nGfxServer2 Script Interface
ngfxserver2:
Super Class:
C++ Class:
Info
Generation 2 gfx server. Completely vertex/pixel shader based.23-Aug-04 kims added setgamma, setbrightness, setcontrast, adjustgamma and restoregamma command.
Commands:
- setdisplaymode
- getdisplaymode
- opendisplay
- closedisplay
- getfeatureset
- savescreenshot
- setcursorvisibility
- setmousecursor
- seticon
- setscissorrect
- getscissorrect
- setgamma
- getgamma
- setbrightness
- getbrightness
- setcontrast
- getcontrast
- adjustgamma
- restoregamma
- setskipmsgloop
setdisplaymode
- Command Input:
s(WindowTitle), s(Type=windowed,fullscreen|alwaysontop), i(XPos), i(YPos), i(Width), i(Height), b(VSync)
- Command Output:
v
- Command Description:
- Set a new display mode. This must happen outside opendisplay/closedisplay.
getdisplaymode
- Command Input:
v
- Command Output:
s(WindowTitle), s(Type=windowed,fullscreen|alwaysontop), i(XPos), i(YPos), i(Width), i(Height), b(VSync)
- Command Description:
- Get the current display mode.
opendisplay
- Command Input:
v
- Command Output:
b(Success)
- Command Description:
- Open the display.
closedisplay
- Command Input:
v
- Command Output:
v
- Command Description:
- Close the display.
getfeatureset
- Command Input:
v
- Command Output:
s(FeatureSet = dx7, dx8, dx8sb, dx9, dx9flt, invalid)
- Command Description:
- Get the feature set implemented by the graphics card.
savescreenshot
- Command Input:
s(Filename)
- Command Output:
v
- Command Description:
- Save a screenshot to the provided filename. A JPG file will be created.
setcursorvisibility
- Command Input:
s('none', 'system', or 'custom')
- Command Output:
v
- Command Description:
- Set whether no cursor, a standard or a custom mouse cursor will be displayed.
setmousecursor
- Command Input:
s (texture resource name), ii (hotspot x, y)
- Command Output:
v
- Command Description:
- Defines a custom mouse cursor.
seticon
- Command Input:
v
- Command Output:
s(icon resource name)
- Command Description:
- Sets the window's icon. This must happen outside opendisplay/closedisplay.
setscissorrect
- Command Input:
f(x0), f(y0), f(x1), f(y1)
- Command Output:
v
- Command Description:
- Define the scissor rectangle (topleft is (0.0f, 0.0f), bottomright is (1.0f, 1.0f)). Note that scissoring must be enabled externally in a shader!
getscissorrect
- Command Input:
v
- Command Output:
f(x0), f(y0), f(x1), f(y1)
- Command Description:
- Returns the current scissor rect.
setgamma
- Command Input:
f
- Command Output:
v
- Command Description:
- Set gamma value (adjustgamma must be called for the change to take effect)
getgamma
- Command Input:
v
- Command Output:
f
- Command Description:
- Get current gamma value (reflects the last call to setgamma, which may not correspond to the actual screen gamma if adjustgamma has not been called).
setbrightness
- Command Input:
f
- Command Output:
v
- Command Description:
- Set brightness value (adjustgamma must be called for the change to take effect)
getbrightness
- Command Input:
v
- Command Output:
f
- Command Description:
- Get current brightness (reflects last call to setbrightness, which may not correspond to the actual screen brightness if adjustgamma has not been called).
setcontrast
- Command Input:
f
- Command Output:
v
- Command Description:
- Set contrast value (adjustgamma must be called for the change to take effect)
getcontrast
- Command Input:
v
- Command Output:
f
- Command Description:
- Get current contrast (reflects last call to setcontrast, which may not correspond to the actual screen contrast if adjustgamma has not been called).
adjustgamma
- Command Input:
v
- Command Output:
v
- Command Description:
- Commits the last gamma, contrast, and brightness values set, so that they are actually visible on the screen. 23-Aug-04 kims created
restoregamma
- Command Input:
v
- Command Output:
v
- Command Description:
- Resets screen gamma to default values.
setskipmsgloop
- Command Input:
b(SkipMsgLoop)
- Command Output:
v
- Command Description:
- Set whether or not the window handler should skip its message loop. This is required when embedding Nebula into an application that provides its own event loop, such as using wxWidgets.
