[ Back to Geeks3D.com ]
 GeeXLab
Laboratory for Real Time 3D Programming (prototyping and demos)
OpenGL, Lua, Python, GLSL,
PhysX and more...Reference Guide
Host-API Lua / Python
» Back to Homepage
» Back to Developer's Guide Index
HYP_Hud Library
HUD (Head Up Display) library
Number of functions: 16
HYP_Hud.Create
Creates a new hud.
: Lua - Python
id [INTEGER]: hud identifier
:
hudId = HYP_Hud.Create()
HYP_Hud.Destroy
Destroys an existing hud.
: Lua - Python
id [INTEGER]: hud identifier
:
HYP_Hud.Destroy(rtId)
HYP_Hud.SetVertexPosition
Sets the position of a HUD's vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
x, y, z [REAL]: position of the vertex.
:
HYP_Hud.SetVertexPosition(hudId, 0, -10.0, 10.0, 0.0, 1.0)
HYP_Hud.GetVertexPosition
Gets the position of a HUD's vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
x, y, z [REAL]: position of the vertex.
HYP_Hud.SetVertexColor
Sets the color of a HUD's vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
r, g, b, a [REAL]: RGBA color of the vertex.
:
HYP_Hud.SetVertexColor(hudId, 0, 0.0, 1.0, 0.0, 1.0)
HYP_Hud.SetVertexColor(hudId, 1, 1.0, 0.0, 0.0, 1.0)
HYP_Hud.SetVertexColor(hudId, 2, 0.0, 0.0, 1.0, 1.0)
HYP_Hud.SetVertexColor(hudId, 3, 0.0, 1.0, 1.0, 1.0)
HYP_Hud.GetVertexColor
Gets the color of a HUD's vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
r, g, b, a [REAL]: RGBA color of the vertex.
HYP_Hud.PushVertices
Pushes all HUD's vertices in an internal stack. Currently this stack has only one level so one push is possible.
: Lua - Python
id [INTEGER]: hud identifier
HYP_Hud.PopVertices
Pops all HUD's vertices from an internal stack.
: Lua - Python
id [INTEGER]: hud identifier
HYP_Hud.SetSize
Sets the size of the hud.
: Lua - Python
id [INTEGER]: hud identifier
width, height [REAL]: new width and height
:
HYP_Hud.SetSize(hudId, 200, 400)
HYP_Hud.GetSize
Gets the size of the hud.
: Lua - Python
id [INTEGER]: hud identifier
width, height [REAL]: new width and height
HYP_Hud.SetVertexTexCoord
Sets the texture coordinate of a HUD specific vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
u, v [REAL]: new UV mapping coordinates.
tu [INTEGER]: texture unit. - Values = [0 - 7]
:
HYP_Hud.SetVertexTexCoord(hudId, 0, 0.23, -0.56, 0)
HYP_Hud.GetVertexTexCoord
Gets the texture coordinate of a HUD specific vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
tu [INTEGER]: texture unit. - Values = [0 - 7]
u, v [REAL]: new UV mapping coordinates.
HYP_Hud.SetVertexTexCoordTiling
Sets the tiling of the texture coordinate of a HUD specific vertex.
: Lua - Python
id [INTEGER]: hud identifier
vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
uTile, vTile [REAL]: tiling factors.
tu [INTEGER]: texture unit. - Values = [0 - 7]
:
HYP_Hud.SetVertexTexCoordTiling(hudId, 0, 2.0, 2.0, 0)
HYP_Hud.ProgressiveDisplay
allows to display progressively a HUD.
: Lua - Python
id [INTEGER]: hud identifier
delay [INTEGER]: displaying delay in milliseconds.
:
HYP_Hud.ProgressiveDisplay(hudId, 1000)
HYP_Hud.ProgressiveUnDisplayWithStretch
allows to hide progressively a HUD.
: Lua - Python
id [INTEGER]: hud identifier
delay [INTEGER]: displaying delay in milliseconds.
stretch_mode [INTEGER]: disappearance mode by stretching. - Values = 0 (no streching), 1 (horizontal streching), 2 (vertical streching)
:
HYP_Hud.ProgressiveUnDisplayWithStretch(hudId, 1000, 0)
HYP_Hud.DoFadeInOut
allows to create an effect of fade-in/fade-out in order to ease transitions in a scene.
: Lua - Python
id [INTEGER]: hud identifier
delay [INTEGER]: displaying delay in milliseconds.
:
HYP_Hud.DoFadeInOut(hudId, 1000)
|
