Deprecated Lua GL

2020-06-19T21:45:29Z

Ivand:

Deprecated Lua GL

2020-06-19T20:15:19Z

Ivand:

* gl.Lighting
* gl.ShadeModel
* gl.Fog
* gl.AlphaTest
* gl.LineStipple
* gl.Material
* gl.Color
* gl.LineWidth
* gl.PointSize
* gl.PointSprite
* gl.PointParameter
* gl.TexEnv
* gl.MultiTexEnv
* gl.TexGen
* gl.MultiTexGen
* gl.Shape
* gl.MultiTexCoord
* gl.SecondaryColor
* gl.FogCoord
* gl.EdgeFlag
* gl.DrawListAtUnit
* gl.Light
* gl.ClipPlane
* gl.CreateList
* gl.CallList
* gl.DeleteList
* gl.GetGlobalTexNames
* gl.GetGlobalTexCoords

* gl.BeginEnd will be probably removed, to discourage creation of JIT temporary VAO/VBO

* Potentially matrix functions Push/Pop/Mode

2019-02-16T21:42:40Z

Ivand: multisample CreateTexture

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Spring =
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" [, "unit"] ) -> nil | number r, number g, number b

'''gl.GetAtmosphere''' {{new|101.0}}
( string name ) -> number r, number g, number b

See [[Lua_UnsyncedCtrl#Sun|Spring.SetAtmosphere]] for details.

'''gl.GetWaterRendering''' {{new|104.0}}
( string name ) -> number r, number g, number b | string texName | number scalar | boolean active | nil

See [[Lua_UnsyncedCtrl#Developers|Spring.SetWaterParams]] for details.

'''gl.GetMapRendering''' {{new|104.0}}
( string name ) -> number r, number g, number b | boolean active | nil

See [[Lua_UnsyncedCtrl#Developers|Spring.SetMapRenderingParams]] for details.

'''gl.ConfigScreen''' used for Unit LODs
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap''' argument new in 0.82+
( boolean tansform = true ) -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

= Matrices & Viewport =
'''gl.Viewport'''
( number x, number y, number w, number h ) -> nil

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
( number x, number y, number z ) -> nil

'''gl.Rotate'''
( number angle, number x, number y, number z ) -> nil

'''gl.Billboard'''
( ) -> nil
Use this to draw 2d primitives in DrawWorld().
To render a 2D billboarded quad in the gameworld at world position x,y,z, you do the following (at a minimum; I am skipping blending / depthtesting) here:
gl.PushMatrix()
gl.Texture(read what you need here)
gl.Translate(x,y,z)
gl.Billboard()
gl.TexRect(x1,y1,x2,y2)
gl.PopMatrix()

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
( ) -> nil

'''gl.LoadMatrix'''
( 16 numbers or a [https://github.com/spring/spring/blob/develop/rts/Lua/LuaOpenGLUtils.cpp#L60 matrix name] ) -> nil

'''gl.MultMatrix'''
( ?? ) -> ??

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''
( ?? ) -> ??

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

= Clear =
'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT [, number cleardepth] ) -> nil
( GL.STENCIL_BUFFER_BIT [, int clearstencil] ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT [, number r, number g, number b, number a] ) -> nil

'''gl.SwapBuffers''' {{new|104.0}}
() -> nil

Available only in LuaMenu, meant for frame-limited LuaMenu's that want identical content in both buffers.

= ResetState/Matrices =
'''gl.ResetState''' DON'T USE IT UNLESS YOU KNOW WHAT YOU ARE DOING! Each call-in has different default states, but this function resets all states to the states below no matter what!
() -> nil

ShadeModel = GL.SMOOTH
Scissor = false
Texture = false
Lighting = false,
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL.LEQUAL)
Culling = false (GL.BACK)
LogicOp = false (GL.INVERT)
AlphaTest = false (GL.GREATER, 0.5f)
Blending = true (GL.SRC_ALPHA, GL.ONE_MINUS_SRC_ALPHA)


'''gl.ResetMatrices'''
() -> nil

Resets GL.TEXTURE matrix stack
Resets GL.MODELVIEW matrix stack
Resets GL.PROJECTION matrix stack


= Draw Basics =
'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

= Display Lists =
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> number listID

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

= Text =
'''gl.Text'''
(string "text", number x, number y, number size [, string "options"] )

options are:
horizontal alignment:
'c' = center
'r' = right
vertical alignment:
'a' = ascender
't' = top
'v' = vertical center
'x' = baseline
'b' = bottom
'd' = descender
decorations:
'o' = black outline
'O' = white outline
's' = shadow
other:
'n' = don't round vertex coords to nearest integer (font may get blurry)

http://home.arcor.de/jkei/fontlines.png

'''gl.GetTextWidth'''
(string "text") -> number width (in pixels, with a font size of 1.0)

'''gl.GetTextHeight'''
( string "text" ) -> nil | number height, number descender, number numlines (in pixels, with a font size of 1.0)
further descriptions here: [[GetTextHeight]]

If you have multiple gl.Text calls, then you can bunch them between a gl.BeginText and gl.EndText to speedup the rendering. 
'''gl.BeginText'''
( ) -> nil
'''gl.EndText'''
( ) -> nil

= Unit/Feature Draw Functions =
'''gl.Unit''' (draws an unit; on default it uses LOD, with lod<0 it is turned off, else it defines a specific level)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (doesn't apply worldspace->unit transformation! only works if rawdraw is true )
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID, bool rawState, bool toScreen, bool opaque ) -> nil

{{new|101.0}} The three extra boolean arguments make it so that calling only these functions is enough to get correctly rendered models; pass in 'false' for the THIRD argument to get the fixed behavior, omit it or pass in 'true' [default] to render with your own custom state instead. The FOURTH argument should be 'true' if in DrawScreen and 'false' (default) if in DrawWorld; any transforms for these two functions *MUST* include a gl.LoadIdentity call when argument #3 is false (whether they are used in DrawWorld or in DrawScreen) the FIFTH argument determines whether the model is drawn opaque ('true' [default]) or with translucency ('false'); only has an effect when argument #3 is false.

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureRaw''' {{new|101.0}}
( number featureID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID, bool custom, bool drawScreen, bool opaque ) -> nil

'''gl.FeatureMultMatrix''' {{new|101.0}} (world space -> feature space)
( number featureID ) -> nil

'''gl.FeaturePieceMultMatrix''' {{new|101.0}} (feature space -> piece space)
( number featureID, int piece ) -> nil

'''gl.FeaturePiece''' {{new|101.0}} (draws the Feature piece)
( number featureID, int piece ) -> nil

'''gl.FeaturePieceMatrix''' {{new|101.0}} (use gl.FeaturePieceMultMatrix instead!)
( number featureID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

= States (Blending,AlphaTest...) =
'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil
( string mode ) -> nil
{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99" | mode maybe:
|-
| style="color:#55ee99" | "add"
| style="color:#55ee99" | = GL.ONE, GL.ONE
|-
| style="color:#55ee99" | "alpha_add"
| style="color:#55ee99" | = GL.SRC_ALPHA, GL.ONE
|-
| style="color:#55ee99" | "alpha"
| style="color:#55ee99" | = GL.SRC_ALPHA, GL.ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "reset"
| style="color:#55ee99" | = GL.SRC_ALPHA, GL.ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "color"
| style="color:#55ee99" | = GL.SRC_COLOR, GL.ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "modulate"
| style="color:#55ee99" | = GL.DST_COLOR, GL.ZERO
|-
| style="color:#55ee99" | "disable"
| style="color:#55ee99" | = GL.SRC_ALPHA, GL.ONE_MINUS_SRC_ALPHA
|}

'''gl.BlendEquation'''
( number mode ) -> nil

'''gl.BlendFunc'''
( number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.BlendEquationSeparate''' (needs openGL2.0!)
( number modeRGB, number modeAlpha ) -> nil

'''gl.BlendFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#BlendingFactorSrc|srcRGB]], number [[Lua_ConstGL#BlendingFactorDest|dstRGB]], number [[Lua_ConstGL#BlendingFactorSrc|srcAlpha]], number [[Lua_ConstGL#BlendingFactorDest|dstAlpha]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthClamp''' not always available, needs GL.NV_depth_clamp!
( boolean enable ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing''' {{removed|104.0}}
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

= Stencil =
'''gl.StencilTest'''
( boolean enable ) -> nil
'''gl.StencilMask'''
( number mask ) -> nil
'''gl.StencilFunc'''
( number func, number ref, number mask ) -> nil
'''gl.StencilOp'''
( number fail, number zfail, number zpass ) -> nil

'''gl.StencilMaskSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number mask ) -> nil
'''gl.StencilFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number func, number ref, number mask ) -> nil
'''gl.StencilOpSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number fail, number zfail, number zpass ) -> nil

= LineWidth & PointSize =
'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize''' (values != 1 can break severely on ATI cards, see http://springrts.com/mantis/view.php?id=2390)
( number size ) -> nil

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

= Textures =
'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded
This is the only call-out that is needed to load and draw any texture in a Lua script. All you have to do is pass it a valid path to a valid png and it will use that image for drawing any subsequent textured rectangles. This is shown in the last line of the following list of valid strings for the name parameter.


{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99; text-align:left" |`name` may be:
|-
| style="color:#55ee99" | #12
| style="color:#55ee99" | = unitDef 12 buildpic
|-
| style="color:#55ee99" | %34:1
| style="color:#55ee99" | = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
|-
| style="color:#55ee99" | %-102:0
| style="color:#55ee99" | = featureDef 102 s3o tex1
|-
| style="color:#55ee99" | !56
| style="color:#55ee99" | = lua generated texture 56 (= return value of gl.CreateTexture)
|-
| style="color:#55ee99" | $units
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units1
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units2
| style="color:#55ee99" | = 3do textureatlas tex2
|-
| style="color:#55ee99" | $shadow
| style="color:#55ee99" | = shadowmap
|-
| style="color:#55ee99" | $specular
| style="color:#55ee99" | = specular cube map (removed in the latest develop)
|-
| style="color:#55ee99" | $reflection
| style="color:#55ee99" | = reflection cube map (can be mipmaped starting from 104.0.1-714-ga29177f. Set CubeTexGenerateMipMaps=1 in settings)
|-
| style="color:#55ee99" | $shading
| style="color:#55ee99" | = ground shading texture
|-
| style="color:#55ee99" | $grass
| style="color:#55ee99" | = grass shading texture
|-
| style="color:#55ee99" | $heightmap
| style="color:#55ee99" | = heightmap (needs HeightMapTexture=1 set in spring config)
|-
| style="color:#55ee99" | $minimap
| style="color:#55ee99" | = minimap texture
|-
| style="color:#55ee99" | $map_reflection
| style="color:#55ee99" | = same as "$reflection" {{new|101.0}}
|-
| style="color:#55ee99" | $sky_reflection
| style="color:#55ee99" | = defined for SSMF maps that have a skyReflectModTex {{new|101.0}}
|-
| style="color:#55ee99" | $detail
| style="color:#55ee99" | = detail texture {{new|101.0}}
|-
| style="color:#55ee99" | $normals
| style="color:#55ee99" | = auto generated normals texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_normals
| style="color:#55ee99" | = SSMF normals texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_specular
| style="color:#55ee99" | = SSMF specular texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_splat_distr
| style="color:#55ee99" | = SSMF splat distribution texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_splat_detail
| style="color:#55ee99" | = SSMF splat detail texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_splat_normals
| style="color:#55ee99" | = SSMF splat normals texture {{new|101.0}}, used as "$ssmf_splat_normals" or "$ssmf_splat_normals:X", 'X' can be a value between 0 and 3, defaults to 0 if ":X" is omitted
|-
| style="color:#55ee99" | $ssmf_emission
| style="color:#55ee99" | = SSMF emission texture {{new|101.0}}
|-
| style="color:#55ee99" | $ssmf_parallax
| style="color:#55ee99" | = SSMF parallax texture {{new|101.0}}
|-
| style="color:#55ee99" | $info
| style="color:#55ee99" | = currently active info texture (los, airlos, radar, jammer) Note that textures contain no data until user switches to their respective modes and non-active textures are not updated in the background, so will go stale
|-
| style="color:#55ee99" | $info_losmap
| style="color:#55ee99" | = los texture (L-view)
|-
| style="color:#55ee99" | $info_mtlmap
| style="color:#55ee99" | = metal map texture (F4-view)
|-
| style="color:#55ee99" | $info_hgtmap
| style="color:#55ee99" | = height map texture (F1-view)
|-
| style="color:#55ee99" | $info_blkmap
| style="color:#55ee99" | = blocking map texture (F2-view)
|-
| style="color:#55ee99" | $map_gbuffer_normtex
| style="color:#55ee99" | = contains the smoothed normals buffer of the map in view in world space coordinates (note that to get true normal vectors from it, you must multiply the vector by 2 and subtract 1) {{new|95}}
|-
| style="color:#55ee99" | $map_gbuffer_difftex
| style="color:#55ee99" | = contains the diffuse texture buffer of the map in view {{new|95}}
|-
| style="color:#55ee99" | $map_gbuffer_spectex
| style="color:#55ee99" | = contains the specular textures of the map in view {{new|95}}
|-
| style="color:#55ee99" | $map_gbuffer_emittex
| style="color:#55ee99" | = for emissive materials (bloom would be the canonical use) {{new|95}}
|-
| style="color:#55ee99" | $map_gbuffer_misctex
| style="color:#55ee99" | = for arbitrary shader data {{new|95}}
|-
| style="color:#55ee99" | $map_gbuffer_zvaltex
| style="color:#55ee99" | = contains the depth values (z-buffer) of the map in view. {{new|95}} To translate this to world position coordinates, use: 

vec4 worldpos= viewProjectionInv * vec4(vec3(gl_TexCoord[0].st,
texture2D( map_gbuffer_zvaltex,gl_TexCoord[0].st ).x) * 2.0 - 1.0 ,1.0);
worldpos.xyz = worldpos.xyz / worldpos.w;
|-
| style="color:#55ee99" | $model_gbuffer_normtex
| style="color:#55ee99" | = contains the smoothed normals buffer of the models in view in world space coordinates (note that to get true normal vectors from it, you must multiply the vector by 2 and subtract 1) {{new|95}}
|-
| style="color:#55ee99" | $model_gbuffer_difftex
| style="color:#55ee99" | = contains the diffuse texture buffer of the models in view {{new|95}}
|-
| style="color:#55ee99" | $model_gbuffer_spectex
| style="color:#55ee99" | = contains the specular textures of the models in view {{new|95}}
|-
| style="color:#55ee99" | $model_gbuffer_emittex
| style="color:#55ee99" | = for emissive materials (bloom would be the canonical use) {{new|95}}
|-
| style="color:#55ee99" | $model_gbuffer_misctex
| style="color:#55ee99" | = for arbitrary shader data {{new|95}}
|-
| style="color:#55ee99" | $model_gbuffer_zvaltex
| style="color:#55ee99" | = contains the depth values (z-buffer) of the models in view. {{new|95}}
|-
| style="color:#55ee99" | ${opt}:/LuaUI/images/image.png
| style="color:#55ee99" | = load a texture from the VFS
|}

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't%r,%g,%b' = tint
'r%width,%height' = resize
The above ${opt}'s are NOT available for .DDS textures! .dds will load faster than other image formats.

example: ":iac:/LuaUI/images/image.png"
example: ":cr16,16:/LuaUI/images/image.png"
example2: ":t1.0,0.5,0:/LuaUI/images/image.png" (orange tint)


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL.TEXTURE_1D,GL.TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean,] (needs GLEW_EXT_framebuffer_object!)
[multisample = boolean] (Added in 104.0.1-10XX-xxxxxxx maintenance)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

The following are primarily intended to be used in conjunction with
gl.{Unit,Feature}(objID, ..., raw=true)
gl.{Unit,Feature}Shape(defID, ..., raw=true)
and apply a model's default textures; easier than gl.Texture("$%...")

'''gl.UnitTextures'''
( number unitID, boolean enable ) -> boolean

'''gl.UnitShapeTextures'''
( number unitDefID, boolean enable ) -> boolean

'''gl.FeatureTextures'''
( number featureID, boolean enable ) -> boolean

'''gl.FeatureShapeTextures'''
( number featureDefID, boolean enable ) -> boolean

= PixelReadback =
'''gl.SaveImage'''
( number x, number y, number w, number h,
string filename [, table {alpha=boolean, yflip=boolean, grayscale16bit=boolean} ] ) -> nil | boolean success

grayscale16bit is {{new|99.0}} and allows to save single color 16bit PNG

'''gl.ReadPixels'''
( number x, number y, number w, number h [, number format = GL.RGBA ] )
-> nil
| number r,[g,[b,[a]]]
| table { { {1 = number r, 2 = number g, 3 = number b, 4 = number a}, ... }, ... }

= Lights =
'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

= Hardware relevant =
'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

= DrawGroundPrimitives =
'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil
Note: number divs is the number of sides the circle will have. the higher the smoother the circle (and more GPU intensive) 

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects. x and z are correspond to the coordinates displayed by the tooltip 
( number x1, number z1, number x2, number z2,
[ boolean useNorm, (does nothing!)
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

= Queries =
'''gl.CreateQuery''' needs >=OpengGL2.0!
( ) -> nil | userdata query
'''gl.DeleteQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil
'''gl.RunQuery''' needs >=OpengGL2.0!
( userdata query, function, arg1, arg2, ... ) -> nil
'''gl.GetQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil | number renderedFragments

= Extended =
'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords''' gets the texcoord of a 3do texture in the 3do texture atlas
( string 3doTextureName ) -> number xstart, number ystart, number xend, number yend

'''gl.UnsafeState'''
( number state [, boolean disable_state ], function, arg1, arg2, ... ) -> nil
Calls glEnable(state) or glDisable(state) (if disable_state==true) and then calls the lua_function and afterwards reverts the state.

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

= Shaders (GLSL) =
[[Lua_GLSL_Api]]

[[category: Lua]]

2018-08-13T17:37:39Z

Ivand:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

These functions are ONLY available if the graphic board supports GLSL. Please test in your scripts if one of them exists before you use them!

'''gl.CreateShader'''
({[ vertex = "glsl code" ,]
[ tcs = "glsl code" ,]
[ tes = "glsl code" ,]
[ geometry = "glsl code" ,]
[ fragment = "glsl code" ,]
[ uniform = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformInt = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformFloat = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformMatrix = { uniformName = number value, ...} ,]
[ geoInputType = number inType,]
[ geoOutputType = number outType,]
[ geoOutputVerts = number maxVerts,]
[ definitions = "string of shader #defines", ]
}) -> number shaderID

* The "Vertex" or vertex-shader is your GLSL-Code as string, its written in a C-Dialect. This shader is busy deforming the geometry of a unit but it can not create new polygons. Use it for waves, wobbling surfaces etc.

* The "Geometry" or Geometry-shader can create new vertices and vertice-stripes from points.

* The "TCS" or Tesselation Control Shader controls how much tessellation a particular patch gets; it also defines the size of a patch, thus allowing it to augment data. It can also filter vertex data taken from the vertex shader. The main purpose of the TCS is to feed the tessellation levels to the Tessellation primitive generator stage, as well as to feed patch data (as its output values) to the Tessellation Evaluation Shader stage. TCS shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "TES" or Tesselation Evaluation Shader takes the abstract patch generated by the tessellation primitive generation stage, as well as the actual vertex data for the entire patch, and generates a particular vertex from it. Each TES invocation generates a single vertex. It can also take per-patch data provided by the Tessellation Control Shader. TES shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "Fragment" or Fragment-shader (sometimes called pixel-Shader) is post processing the allready rendered picture (for example drawing stars on the sky)- remember textures are not always 2 dimensional pictures. They can contain information about the depth, or the third value marks areas and the strength at which these are processed.

* The Uniforms are the values, you send along with the shader-program. To use them in the shader-program declare them like this:
<syntaxhighlight lang="c">uniform float frame;</syntaxhighlight>

* From 101.0 onwards, the engine will automatically fill in an appropriately named uniform for team colour if it is declared;
<syntaxhighlight lang="c">uniform vec4 teamColor;</syntaxhighlight>

'''gl.DeleteShader'''
( number shaderID ) -> nil

'''gl.ActiveShader''' can be used in none drawing events (to update uniforms etc.)!
( number shaderID, function [, arg1 [, arg2, ..]] ) -> nil

'''gl.UseShader'''
( number shaderID ) -> boolean linked

'''gl.GetShaderLog'''
( ) -> string "infoLog"

'''gl.SetShaderParameter'''
Renamed to SetGeometryShaderParameter in spring version >= 104.0.1-596 (maintenance).
needed by geometry shader programs (check the opengl GL_ARB_geometry_shader4 extension for glProgramParameteri)
( number shaderID, number param, number value ) -> nil

'''gl.SetTesselationShaderParameter'''
Available for spring versions >= 104.0.1-596 (maintenance).
needed by tesselation shader programs (check the opengl GL_ARB_tessellation_shader extension for glProgramParameteri)
( number param, number value ) -> nil

'''gl.GetActiveUniforms'''
( number shaderID ) -> {
[1] = { name = "name", type = "type", length = number length, size = number size },
...
}

'''gl.GetUniformLocation'''
( number shaderID, name uniformName ) -> number locationID

'''gl.Uniform'''
( number locationID, number f1 [,number f2 [,number f3 [,number f4]]] ) -> nil

'''gl.UniformInt'''
( number locationID, number int1 [,number int2 [,number int3 [,number int4]]] ) -> nil

'''gl.UniformArray''' {{new|95.0}}
( number locationID, number type, table uniforms ) -> nil
type can be one of {1 = int, 2 = float, 3 = float matrix}. In 104.0 the maximum length of the uniforms table increased from 32 entries to 1024.

'''gl.UniformMatrix'''
( number locationID,
"shadow" |
"camera" |
"caminv" |
"camprj" |
number m1, number m2, number m3, number m4 |
number m1, ... , number m9 |
number m1, ... , number m16
) -> nil

[[category: Lua]]

Lua GLSL Api

2018-08-13T17:36:50Z

Ivand:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

These functions are ONLY available if the graphic board supports GLSL. Please test in your scripts if one of them exists before you use them!

'''gl.CreateShader'''
({[ vertex = "glsl code" ,]
[ tcs = "glsl code" ,]
[ tes = "glsl code" ,]
[ geometry = "glsl code" ,]
[ fragment = "glsl code" ,]
[ uniform = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformInt = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformFloat = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformMatrix = { uniformName = number value, ...} ,]
[ geoInputType = number inType,]
[ geoOutputType = number outType,]
[ geoOutputVerts = number maxVerts,]
[ definitions = "string of shader #defines", ]
}) -> number shaderID

* The "Vertex" or vertex-shader is your GLSL-Code as string, its written in a C-Dialect. This shader is busy deforming the geometry of a unit but it can not create new polygons. Use it for waves, wobbling surfaces etc.

* The "Geometry" or Geometry-shader can create new vertices and vertice-stripes from points.

* The "TCS" or Tesselation Control Shader controls how much tessellation a particular patch gets; it also defines the size of a patch, thus allowing it to augment data. It can also filter vertex data taken from the vertex shader. The main purpose of the TCS is to feed the tessellation levels to the Tessellation primitive generator stage, as well as to feed patch data (as its output values) to the Tessellation Evaluation Shader stage. TCS shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "TES" or Tesselation Evaluation Shader takes the abstract patch generated by the tessellation primitive generation stage, as well as the actual vertex data for the entire patch, and generates a particular vertex from it. Each TES invocation generates a single vertex. It can also take per-patch data provided by the Tessellation Control Shader. TES shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "Fragment" or Fragment-shader (sometimes called pixel-Shader) is post processing the allready rendered picture (for example drawing stars on the sky)- remember textures are not always 2 dimensional pictures. They can contain information about the depth, or the third value marks areas and the strength at which these are processed.

* The Uniforms are the values, you send along with the shader-program. To use them in the shader-program declare them like this:
<syntaxhighlight lang="c">uniform float frame;</syntaxhighlight>

* From 101.0 onwards, the engine will automatically fill in an appropriately named uniform for team colour if it is declared;
<syntaxhighlight lang="c">uniform vec4 teamColor;</syntaxhighlight>

'''gl.DeleteShader'''
( number shaderID ) -> nil

'''gl.ActiveShader''' can be used in none drawing events (to update uniforms etc.)!
( number shaderID, function [, arg1 [, arg2, ..]] ) -> nil

'''gl.UseShader'''
( number shaderID ) -> boolean linked

'''gl.GetShaderLog'''
( ) -> string "infoLog"

'''gl.SetShaderParameter'''
Renamed to SetGeometryShaderParameter in spring version >= 104.0.1-596 (maintenance).
needed by geometry shader programs (check the opengl GL_ARB_geometry_shader4 extension for glProgramParameteri)
( number shaderID, number param, number value ) -> nil

'''gl.SetTesselationShaderParameter'''
Available for spring versions >= 104.0.1-596 (maintenance).
needed by tesselation shader programs (check the opengl GL_ARB_tessellation_shader extension for glProgramParameteri)
( number param, number value ) -> nil

'''gl.GetActiveUniforms'''
( number shaderID ) -> {
[1] = { name = "name", type = "type", length = number length, size = number size },
...
}

'''gl.GetUniformLocation'''
( number shaderID, name uniformName ) -> number locationID

'''gl.Uniform'''
( number locationID, number f1 [,number f2 [,number f3 [,number f4]]] ) -> nil

'''gl.UniformInt'''
( number locationID, number int1 [,number int2 [,number int3 [,number int4]]] ) -> nil

'''gl.UniformArray''' {{new|95.0}}
( number locationID, number type, table uniforms ) -> nil
type can be one of {1 = int, 2 = float}. In 104.0 the maximum length of the uniforms table increased from 32 entries to 1024.

'''gl.UniformMatrix'''
( number locationID,
"shadow" |
"camera" |
"caminv" |
"camprj" |
number m1, number m2, number m3, number m4 |
number m1, ... , number m9 |
number m1, ... , number m16
) -> nil

[[category: Lua]]

Lua GLSL Api

2018-08-12T14:23:07Z

Ivand:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

These functions are ONLY available if the graphic board supports GLSL. Please test in your scripts if one of them exists before you use them!

'''gl.CreateShader'''
({[ vertex = "glsl code" ,]
[ tcs = "glsl code" ,]
[ tes = "glsl code" ,]
[ geometry = "glsl code" ,]
[ fragment = "glsl code" ,]
[ uniform = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformInt = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformFloat = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
[ uniformMatrix = { uniformName = number value, ...} ,]
[ geoInputType = number inType,]
[ geoOutputType = number outType,]
[ geoOutputVerts = number maxVerts,]
[ definitions = "string of shader #defines", ]
}) -> number shaderID

* The "Vertex" or vertex-shader is your GLSL-Code as string, its written in a C-Dialect. This shader is busy deforming the geometry of a unit but it can not create new polygons. Use it for waves, wobbling surfaces etc.

* The "Geometry" or Geometry-shader can create new vertices and vertice-stripes from points.

* The "TCS" or Tesselation Control Shader controls how much tessellation a particular patch gets; it also defines the size of a patch, thus allowing it to augment data. It can also filter vertex data taken from the vertex shader. The main purpose of the TCS is to feed the tessellation levels to the Tessellation primitive generator stage, as well as to feed patch data (as its output values) to the Tessellation Evaluation Shader stage. TCS shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "TES" or Tesselation Evaluation Shader takes the abstract patch generated by the tessellation primitive generation stage, as well as the actual vertex data for the entire patch, and generates a particular vertex from it. Each TES invocation generates a single vertex. It can also take per-patch data provided by the Tessellation Control Shader. TES shader can be used with spring version >= 104.0.1-596 (maintenance), it's also available in develop branch of spring.

* The "Fragment" or Fragment-shader (sometimes called pixel-Shader) is post processing the allready rendered picture (for example drawing stars on the sky)- remember textures are not always 2 dimensional pictures. They can contain information about the depth, or the third value marks areas and the strength at which these are processed.

* The Uniforms are the values, you send along with the shader-program. To use them in the shader-program declare them like this:
<syntaxhighlight lang="c">uniform float frame;</syntaxhighlight>

* From 101.0 onwards, the engine will automatically fill in an appropriately named uniform for team colour if it is declared;
<syntaxhighlight lang="c">uniform vec4 teamColor;</syntaxhighlight>

'''gl.DeleteShader'''
( number shaderID ) -> nil

'''gl.ActiveShader''' can be used in none drawing events (to update uniforms etc.)!
( number shaderID, function [, arg1 [, arg2, ..]] ) -> nil

'''gl.UseShader'''
( number shaderID ) -> boolean linked

'''gl.GetShaderLog'''
( ) -> string "infoLog"

'''gl.SetShaderParameter'''
Renamed to SetGeometryShaderParameter in spring version >= 104.0.1-596 (maintenance).
needed by geometry shader programs (check the opengl GL_ARB_geometry_shader4 extension for glProgramParameteri)
( number shaderID, number param, number value ) -> nil

'''gl.SetTesselationShaderParameter'''
Available for spring versions >= 104.0.1-596 (maintenance).
needed by tesselation shader programs (check the opengl GL_ARB_tessellation_shader extension for glProgramParameteri)
( number param, number value ) -> nil

'''gl.GetActiveUniforms'''
( number shaderID ) -> {
[1] = { name = "name", type = "type", length = number length, size = number size },
...
}

'''gl.GetUniformLocation'''
( number shaderID, name uniformName ) -> number locationID

'''gl.Uniform'''
( number locationID, number f1 [,number f2 [,number f3 [,number f4]]] ) -> nil

'''gl.UniformInt'''
( number locationID, number int1 [,number int2 [,number int3 [,number int4]]] ) -> nil

'''gl.UniformArray''' {{new|95.0}}
( number locationID, number type, table uniforms ) -> nil
type can be one of {0 = int, 1 = float}. In 104.0 the maximum length of the uniforms table increased from 32 entries to 1024.

'''gl.UniformMatrix'''
( number locationID,
"shadow" |
"camera" |
"caminv" |
"camprj" |
number m1, number m2, number m3, number m4 |
number m1, ... , number m9 |
number m1, ... , number m16
) -> nil

[[category: Lua]]