blob: fc8a2d625d8c6c9d79c1819782103b6881bd2f83 [file] [log] [blame]
##########################################################################
#
# Copyright 2011 Jose Fonseca
# All Rights Reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
##########################################################################/
'''Describe GL types.'''
import platform
from .stdapi import *
GLboolean = Enum("GLboolean", [
"GL_TRUE",
"GL_FALSE",
])
GLvoid = Alias("GLvoid", Void)
GLbyte = Alias("GLbyte", SChar)
GLshort = Alias("GLshort", Short)
GLint = Alias("GLint", Int)
GLint64 = Alias("GLint64", Int64)
GLubyte = Alias("GLubyte", UChar)
GLushort = Alias("GLushort", UShort)
GLuint = Alias("GLuint", UInt)
GLuint64 = Alias("GLuint64", UInt64)
GLsizei = Alias("GLsizei", Int)
GLintptr = Alias("GLintptr", Int)
GLsizeiptr = Alias("GLsizeiptr", Int)
GLfloat = Alias("GLfloat", Float)
GLclampf = Alias("GLclampf", Float)
GLdouble = Alias("GLdouble", Double)
GLclampd = Alias("GLclampd", Double)
GLchar = Alias("GLchar", Char)
GLfixed = Alias("GLfixed", Int32)
GLclampx = Alias("GLclampx", Int32)
GLcharARB = Alias("GLcharARB", SChar)
GLintptrARB = Alias("GLintptrARB", Int)
GLsizeiptrARB = Alias("GLsizeiptrARB", Int)
GLhandleARB = Handle("handleARB", Alias("GLhandleARB", UInt))
GLhalfARB = Alias("GLhalfARB", UShort)
GLhalfNV = Alias("GLhalfNV", UShort)
GLint64EXT = Alias("GLint64EXT", Int64)
GLuint64EXT = Alias("GLuint64EXT", UInt64)
GLDEBUGPROC = Opaque("GLDEBUGPROC")
GLDEBUGPROCKHR = Opaque("GLDEBUGPROCKHR")
GLDEBUGPROCARB = Opaque("GLDEBUGPROCARB")
GLDEBUGPROCAMD = Opaque("GLDEBUGPROCAMD")
GLstring = String(GLchar)
GLstringConst = String(Const(GLchar))
GLstringARB = String(GLcharARB)
GLstringConstARB = String(Const(GLcharARB))
GLpointer = OpaquePointer(GLvoid)
GLpointerConst = OpaquePointer(Const(GLvoid))
GLlist = Handle("list", GLuint)
GLtexture = Handle("texture", GLuint)
GLbuffer = Handle("buffer", GLuint)
GLquery = Handle("query", GLuint)
GLfenceNV = Handle("fenceNV", GLuint)
GLprogram = Handle("program", GLuint)
GLshader = Handle("shader", GLuint)
# Share the same mapping table for uniform locations of both core and
# GL_ARB_shader_objects programs. For a combination of reasons:
#
# - all OpenGL implementations appear to alias the names for both kind of
# programs;
#
# - most applications will use only one kind of shader programs;
#
# - some applications actually mix glUniformXxx calls with
# GL_ARB_shader_objects programs and glUniformXxxARB calls with core
# programs, and therefore, rely on a joint implementation.
#
# We use GLhandleARB as program key, since it is wider (void *) on MacOSX.
#
GLlocation = Handle("location", GLint, key=('program', GLhandleARB))
GLlocationARB = Handle("location", GLint, key=('programObj', GLhandleARB))
# TODO: Symbolic representation of GL_INVALID_INDEX
GLuniformBlock = Handle("uniformBlock", GLuint, key=('program', GLprogram))
contextKey = ('reinterpret_cast<uintptr_t>(glretrace::getCurrentContext())', UIntPtr)
GLprogramARB = Handle("programARB", GLuint)
GLframebuffer = Handle("framebuffer", GLuint)
GLrenderbuffer = Handle("renderbuffer", GLuint)
GLfragmentShaderATI = Handle("fragmentShaderATI", GLuint)
GLarray = Handle("array", GLuint, key=contextKey) # per-context
GLarrayAPPLE = Handle("arrayAPPLE", GLuint) # shared
GLregion = Handle("region", GLuint)
GLpipeline = Handle("pipeline", GLuint)
GLsampler = Handle("sampler", GLuint)
GLfeedback = Handle("feedback", GLuint)
GLfence = Handle("fence", GLuint)
GLtextureHandle = Handle("textureHandle", GLuint64)
GLimageHandle = Handle("imageHandle", GLuint64)
GLsubroutine = Handle("subroutine", GLuint, key=('program', GLhandleARB))
# GL mappings are pointers to linear memory regions.
#
# The map length is not always available in the function prototype, and must be
# reconstructed from other state.
GLmap = LinearPointer(GLvoid, "length")
GLsync = Handle("sync", IntPointer("GLsync"))
GLenum = Enum("GLenum", [
# Parameters are added later from glparams.py's parameter table
])
# Some functions take GLenum disguised as GLint, and need special treatment so
# that symbolic names are traced correctly.
GLenum_int = Alias("GLint", GLenum)
GLenum_mode = FakeEnum(GLenum, [
"GL_POINTS", # 0x0000
"GL_LINES", # 0x0001
"GL_LINE_LOOP", # 0x0002
"GL_LINE_STRIP", # 0x0003
"GL_TRIANGLES", # 0x0004
"GL_TRIANGLE_STRIP", # 0x0005
"GL_TRIANGLE_FAN", # 0x0006
"GL_QUADS", # 0x0007
"GL_QUAD_STRIP", # 0x0008
"GL_POLYGON", # 0x0009
"GL_LINES_ADJACENCY", # 0x000A
"GL_LINE_STRIP_ADJACENCY", # 0x000B
"GL_TRIANGLES_ADJACENCY", # 0x000C
"GL_TRIANGLE_STRIP_ADJACENCY", # 0x000D
"GL_PATCHES", # 0x000E
])
GLenum_error = FakeEnum(GLenum, [
"GL_NO_ERROR", # 0x0
"GL_INVALID_ENUM", # 0x0500
"GL_INVALID_VALUE", # 0x0501
"GL_INVALID_OPERATION", # 0x0502
"GL_STACK_OVERFLOW", # 0x0503
"GL_STACK_UNDERFLOW", # 0x0504
"GL_OUT_OF_MEMORY", # 0x0505
"GL_INVALID_FRAMEBUFFER_OPERATION", # 0x0506
"GL_TABLE_TOO_LARGE", # 0x8031
])
GLenum_region = FakeEnum(GLenum, [
"GL_KTX_FRONT_REGION",
"GL_KTX_BACK_REGION",
"GL_KTX_Z_REGION",
"GL_KTX_STENCIL_REGION",
])
GLbitfield = Alias("GLbitfield", UInt)
GLbitfield_attrib = Flags(GLbitfield, [
"GL_ALL_ATTRIB_BITS", # 0x000FFFFF
"GL_CURRENT_BIT", # 0x00000001
"GL_POINT_BIT", # 0x00000002
"GL_LINE_BIT", # 0x00000004
"GL_POLYGON_BIT", # 0x00000008
"GL_POLYGON_STIPPLE_BIT", # 0x00000010
"GL_PIXEL_MODE_BIT", # 0x00000020
"GL_LIGHTING_BIT", # 0x00000040
"GL_FOG_BIT", # 0x00000080
"GL_DEPTH_BUFFER_BIT", # 0x00000100
"GL_ACCUM_BUFFER_BIT", # 0x00000200
"GL_STENCIL_BUFFER_BIT", # 0x00000400
"GL_VIEWPORT_BIT", # 0x00000800
"GL_TRANSFORM_BIT", # 0x00001000
"GL_ENABLE_BIT", # 0x00002000
"GL_COLOR_BUFFER_BIT", # 0x00004000
"GL_HINT_BIT", # 0x00008000
"GL_EVAL_BIT", # 0x00010000
"GL_LIST_BIT", # 0x00020000
"GL_TEXTURE_BIT", # 0x00040000
"GL_SCISSOR_BIT", # 0x00080000
"GL_MULTISAMPLE_BIT", # 0x20000000
])
GLbitfield_client_attrib = Flags(GLbitfield, [
"GL_CLIENT_ALL_ATTRIB_BITS", # 0xFFFFFFFF
"GL_CLIENT_PIXEL_STORE_BIT", # 0x00000001
"GL_CLIENT_VERTEX_ARRAY_BIT", # 0x00000002
])
GLbitfield_shader = Flags(GLbitfield, [
"GL_ALL_SHADER_BITS", # 0xFFFFFFFF
"GL_VERTEX_SHADER_BIT", # 0x00000001
"GL_FRAGMENT_SHADER_BIT", # 0x00000002
"GL_GEOMETRY_SHADER_BIT", # 0x00000004
"GL_TESS_CONTROL_SHADER_BIT", # 0x00000008
"GL_TESS_EVALUATION_SHADER_BIT", # 0x00000010
"GL_COMPUTE_SHADER_BIT", # 0x00000020
])
GLbitfield_access = Flags(GLbitfield, [
"GL_MAP_READ_BIT", # 0x0001
"GL_MAP_WRITE_BIT", # 0x0002
"GL_MAP_INVALIDATE_RANGE_BIT", # 0x0004
"GL_MAP_INVALIDATE_BUFFER_BIT", # 0x0008
"GL_MAP_FLUSH_EXPLICIT_BIT", # 0x0010
"GL_MAP_UNSYNCHRONIZED_BIT", # 0x0020
"GL_MAP_PERSISTENT_BIT", # 0x0040
"GL_MAP_COHERENT_BIT", # 0x0080
])
GLbitfield_storage = Flags(GLbitfield, [
"GL_MAP_READ_BIT", # 0x0001 (existing)
"GL_MAP_WRITE_BIT", # 0x0002 (existing)
"GL_MAP_PERSISTENT_BIT", # 0x0040
"GL_MAP_COHERENT_BIT", # 0x0080
"GL_DYNAMIC_STORAGE_BIT", # 0x0100
"GL_CLIENT_STORAGE_BIT", # 0x0200
])
GLbitfield_sync_flush = Flags(GLbitfield, [
"GL_SYNC_FLUSH_COMMANDS_BIT", # 0x00000001
])
GLbitfield_barrier = Flags(GLbitfield, [
"GL_ALL_BARRIER_BITS", # 0xFFFFFFFF
"GL_VERTEX_ATTRIB_ARRAY_BARRIER_BIT", # 0x00000001
"GL_ELEMENT_ARRAY_BARRIER_BIT", # 0x00000002
"GL_UNIFORM_BARRIER_BIT", # 0x00000004
"GL_TEXTURE_FETCH_BARRIER_BIT", # 0x00000008
"GL_SHADER_GLOBAL_ACCESS_BARRIER_BIT_NV", # 0x00000010
"GL_SHADER_IMAGE_ACCESS_BARRIER_BIT", # 0x00000020
"GL_COMMAND_BARRIER_BIT", # 0x00000040
"GL_PIXEL_BUFFER_BARRIER_BIT", # 0x00000080
"GL_TEXTURE_UPDATE_BARRIER_BIT", # 0x00000100
"GL_BUFFER_UPDATE_BARRIER_BIT", # 0x00000200
"GL_FRAMEBUFFER_BARRIER_BIT", # 0x00000400
"GL_TRANSFORM_FEEDBACK_BARRIER_BIT", # 0x00000800
"GL_ATOMIC_COUNTER_BARRIER_BIT", # 0x00001000
"GL_SHADER_STORAGE_BARRIER_BIT", # 0x00002000
"GL_CLIENT_MAPPED_BUFFER_BARRIER_BIT", # 0x00004000
"GL_QUERY_BUFFER_BARRIER_BIT", # 0x00008000
])
GLbitfield_metricQueryMask = Flags(GLbitfield, [
"GL_GLYPH_WIDTH_BIT_NV", # 0x01
"GL_GLYPH_HEIGHT_BIT_NV", # 0x02
"GL_GLYPH_HORIZONTAL_BEARING_X_BIT_NV", # 0x04
"GL_GLYPH_HORIZONTAL_BEARING_Y_BIT_NV", # 0x08
"GL_GLYPH_HORIZONTAL_BEARING_ADVANCE_BIT_NV", # 0x10
"GL_GLYPH_VERTICAL_BEARING_X_BIT_NV", # 0x20
"GL_GLYPH_VERTICAL_BEARING_Y_BIT_NV", # 0x40
"GL_GLYPH_VERTICAL_BEARING_ADVANCE_BIT_NV", # 0x80
"GL_GLYPH_HAS_KERNING_BIT_NV", # 0x100
"GL_FONT_X_MIN_BOUNDS_BIT_NV", # 0x00010000
"GL_FONT_Y_MIN_BOUNDS_BIT_NV", # 0x00020000
"GL_FONT_X_MAX_BOUNDS_BIT_NV", # 0x00040000
"GL_FONT_Y_MAX_BOUNDS_BIT_NV", # 0x00080000
"GL_FONT_UNITS_PER_EM_BIT_NV", # 0x00100000
"GL_FONT_ASCENDER_BIT_NV", # 0x00200000
"GL_FONT_DESCENDER_BIT_NV", # 0x00400000
"GL_FONT_HEIGHT_BIT_NV", # 0x00800000
"GL_FONT_MAX_ADVANCE_WIDTH_BIT_NV", # 0x01000000
"GL_FONT_MAX_ADVANCE_HEIGHT_BIT_NV", # 0x02000000
"GL_FONT_UNDERLINE_POSITION_BIT_NV", # 0x04000000
"GL_FONT_UNDERLINE_THICKNESS_BIT_NV", # 0x08000000
"GL_FONT_HAS_KERNING_BIT_NV", # 0x10000000
])
GLbitfield_fontStyle = Flags(GLbitfield, [
"GL_BOLD_BIT_NV", # 0x01
"GL_ITALIC_BIT_NV", # 0x02
])
# GL_ARB_vertex_array_bgra
size_bgra = FakeEnum(GLint, [
"GL_BGRA",
])
def GLindexBuffer(countExpr, typeExpr):
# Indices arguments are polymorphic:
# - offsets when element array buffer is bound
# - or a blob otherwise.
sizeExpr = '%s*_gl_type_size(%s)' % (countExpr, typeExpr)
return Polymorphic('_element_array_buffer_binding()', [
('0', Blob(Const(GLvoid), sizeExpr)),
],
IntPointer("const GLvoid *"),
contextLess=False,
)
# Polymorphic object name
def GLname(targetExpr):
return Polymorphic(targetExpr, [
('GL_BUFFER', GLbuffer),
('GL_SHADER', GLshader),
('GL_PROGRAM', GLprogram),
('GL_VERTEX_ARRAY', GLarray),
('GL_QUERY', GLquery),
('GL_PROGRAM_PIPELINE', GLpipeline),
('GL_TRANSFORM_FEEDBACK', GLuint),
('GL_SAMPLER', GLsampler),
('GL_TEXTURE', GLtexture),
('GL_TEXTURE_1D', GLtexture),
('GL_TEXTURE_1D_ARRAY', GLtexture),
('GL_TEXTURE_2D', GLtexture),
('GL_TEXTURE_2D_MULTISAMPLE', GLtexture),
('GL_TEXTURE_2D_ARRAY', GLtexture),
('GL_TEXTURE_RECTANGLE', GLtexture),
('GL_TEXTURE_CUBE_MAP', GLtexture),
('GL_TEXTURE_CUBE_MAP_POSITIVE_X', GLtexture),
('GL_TEXTURE_CUBE_MAP_NEGATIVE_X', GLtexture),
('GL_TEXTURE_CUBE_MAP_POSITIVE_Y', GLtexture),
('GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', GLtexture),
('GL_TEXTURE_CUBE_MAP_POSITIVE_Z', GLtexture),
('GL_TEXTURE_CUBE_MAP_NEGATIVE_Z', GLtexture),
('GL_TEXTURE_CUBE_MAP_ARRAY', GLtexture),
('GL_TEXTURE_3D', GLtexture),
('GL_RENDERBUFFER', GLrenderbuffer),
('GL_FRAMEBUFFER', GLframebuffer),
('GL_DISPLAY_LIST', GLlist),
('GL_FENCE_APPLE', GLfence),
('GL_DRAW_PIXELS_APPLE', GLuint), # GL_APPLE_fence
], GLuint)
# GL_AMD_performance_monitor
GLperfMonitorCounterInfoAMD = Polymorphic('pname', [
('GL_COUNTER_TYPE_AMD', Pointer(GLenum)),
('GL_PERCENTAGE_AMD', Pointer(Float)),
('GL_COUNTER_RANGE_AMD', Array(Float, 2)),
],
OpaquePointer(GLvoid),
)
# GL_AMD_sparse_texture
GLbitfield_texStorageSparse = Flags(GLbitfield, [
'GL_TEXTURE_STORAGE_SPARSE_BIT_AMD', # 0x00000001
])
# GL_NV_vdpau_interop
GLvdpauSurfaceNV = Alias('GLvdpauSurfaceNV', GLintptr)