"No one can be told what GeeXLab is, you have to see it for yourself!"

"Stop Playing Games and Start Making Them! With GeeXLab, your are on your way!"


Quick Links
What is GeeXLab
Download GeeXLab
GeeXLab Requirements
Online Help
Articles and Tutorials
Samples Screenshots
Videos

GeeXLab Changelog

XML Ref. Guide
Scripting Ref. Guide
Code Samples

Purchase GeeXLab
GeeXLab SDK

Shader Library

Follow GeeXLab's News
GeeXLab news, articles, tutorials and demos @ Geeks3D.com
GeeXLab @ Twitter GeeXLab RSS Feed

Subscribe to GeeXLab news by email

[ Back to Geeks3D.com ]

GeeXLab

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


Description
HUD (Head Up Display) library

Number of functions: 16

HYP_Hud.Create

Description
Creates a new hud.

Languages: Lua - Python

Return Values
  • id [INTEGER]: hud identifier

    Code sample :

    hudId = HYP_Hud.Create()


    HYP_Hud.Destroy

    Description
    Destroys an existing hud.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier

    Code sample :

    HYP_Hud.Destroy(rtId)


    HYP_Hud.SetVertexPosition

    Description
    Sets the position of a HUD's vertex.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
  • x, y, z [REAL]: position of the vertex.

    Code sample :

    HYP_Hud.SetVertexPosition(hudId, 0, -10.0, 10.0, 0.0, 1.0)


    HYP_Hud.GetVertexPosition

    Description
    Gets the position of a HUD's vertex.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3

    Return Values
  • x, y, z [REAL]: position of the vertex.

    HYP_Hud.SetVertexColor

    Description
    Sets the color of a HUD's vertex.

    Languages: Lua - Python

    Parameters
  • 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.

    Code sample :

    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

    Description
    Gets the color of a HUD's vertex.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3

    Return Values
  • r, g, b, a [REAL]: RGBA color of the vertex.

    HYP_Hud.PushVertices

    Description
    Pushes all HUD's vertices in an internal stack. Currently this stack has only one level so one push is possible.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier

    HYP_Hud.PopVertices

    Description
    Pops all HUD's vertices from an internal stack.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier

    HYP_Hud.SetSize

    Description
    Sets the size of the hud.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • width, height [REAL]: new width and height

    Code sample :

    HYP_Hud.SetSize(hudId, 200, 400)


    HYP_Hud.GetSize

    Description
    Gets the size of the hud.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier

    Return Values
  • width, height [REAL]: new width and height

    HYP_Hud.SetVertexTexCoord

    Description
    Sets the texture coordinate of a HUD specific vertex.

    Languages: Lua - Python

    Parameters
  • 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]

    Code sample :

    HYP_Hud.SetVertexTexCoord(hudId, 0, 0.23, -0.56, 0)


    HYP_Hud.GetVertexTexCoord

    Description
    Gets the texture coordinate of a HUD specific vertex.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • vertexIndex [INTEGER]: index of the vertex. - Values = 0|1|2|3
  • tu [INTEGER]: texture unit. - Values = [0 - 7]

    Return Values
  • u, v [REAL]: new UV mapping coordinates.

    HYP_Hud.SetVertexTexCoordTiling

    Description
    Sets the tiling of the texture coordinate of a HUD specific vertex.

    Languages: Lua - Python

    Parameters
  • 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]

    Code sample :

    HYP_Hud.SetVertexTexCoordTiling(hudId, 0, 2.0, 2.0, 0)


    HYP_Hud.ProgressiveDisplay

    Description
    allows to display progressively a HUD.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • delay [INTEGER]: displaying delay in milliseconds.

    Code sample :

    HYP_Hud.ProgressiveDisplay(hudId, 1000)


    HYP_Hud.ProgressiveUnDisplayWithStretch

    Description
    allows to hide progressively a HUD.

    Languages: Lua - Python

    Parameters
  • 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)

    Code sample :

    HYP_Hud.ProgressiveUnDisplayWithStretch(hudId, 1000, 0)


    HYP_Hud.DoFadeInOut

    Description
    allows to create an effect of fade-in/fade-out in order to ease transitions in a scene.

    Languages: Lua - Python

    Parameters
  • id [INTEGER]: hud identifier
  • delay [INTEGER]: displaying delay in milliseconds.

    Code sample :

    HYP_Hud.DoFadeInOut(hudId, 1000)




  • Random Projects

    Pixelation PostFX
    Pixelation PostFX

    2D Shockwave Effect
    2D Shockwave Effect

    Thermal Vision PostFX
    Thermal Vision PostFX


    Random Code Samples

    Python - PyOpenGL
    Python - PyOpenGL

    Draw Line
    Draw Line

    Model Cloning
    Model Cloning



    (C)2009-2010 Geeks3D.com