Interface FlowRender
access this type via: ui.FlowRender (provides, requires or uses)
FlowRender is a direct rendering API, generally used by applications such as video games. All of the functions in this API must only be called from the main thread of your program.
Constants
byte CURSOR_DEFAULT
byte CURSOR_HIDDEN
byte CURSOR_CUSTOM
byte CURSOR_IBEAM
byte CURSOR_HAND
byte CURSOR_WAIT
byte CURSOR_SIZENS
byte CURSOR_SIZEWE
byte CURSOR_SIZENWSE
byte CURSOR_SIZENESW
byte CURSOR_SIZEALL
Functions
FlowRender(optional int framerate)
void setVisible(bool v)
void setResizable(bool v)
void setFullScreen(bool v)
void setTitle(char title[])
void setPosition(int x, int y)
void setSize(int w, int h)
void setCursor(byte cursorType,
optional Cursor c)
PixelMap getPixels(
optional byte pixelFormat)
void close()
void renderBegin()
void renderEnd()
void wait()
byte getPixelFormat()
Constants
CURSOR_DEFAULT A value for setCursor() to select the system-default mouse cursor.
CURSOR_HIDDEN A value for setCursor() to hide the mouse cursor.
CURSOR_CUSTOM A value for setCursor() to select a custom mouse cursor, alongside a pixel map.
CURSOR_IBEAM A value for setCursor() to select an I-beam (often used in text areas).
CURSOR_HAND A value for setCursor() to select a hand.
CURSOR_WAIT A value for setCursor() to select a 'wait for something' cursor.
CURSOR_SIZENS A value for setCursor() to select a north-south arrow.
CURSOR_SIZEWE A value for setCursor() to select a west-east arrow.
CURSOR_SIZENWSE A value for setCursor() to select a north-west-south-east arrow.
CURSOR_SIZENESW A value for setCursor() to select a north-east-south-west arrow.
CURSOR_SIZEALL A value for setCursor() to select an every-direction arrow.
FlowRender(optional int framerate)
Initialise a new direct rendering window, optionally specifying a target framerate.
Get the input events which have arrived since this function was last called.
void setVisible(bool v)
Hide/show the window.
void setResizable(bool v)
Set the window as user-resizeable or not.
void setFullScreen(bool v)
Set the window as full-screen or not.
void setTitle(char title[])
Set the title of the window.
Set the image used for the icon of the window.
void setPosition(int x, int y)
Set the x/y position of the window on the screen.
void setSize(int w, int h)
Set the width and height of the window.
void setCursor(byte cursorType,
optional Cursor c)
Set the current mouse cursor of the window, from one of the CURSOR_ constants.
Get the screen resolution of the display on which the window resides.
PixelMap getPixels(
optional byte pixelFormat)
Get the window's rendered content as a pixel map.
void close()
Close the window (other functions on this API will not work after this).
void renderBegin()
Begin a new render sequence to draw a scene. Call renderEnd() to finish that scene and present it.
void renderEnd()
Finish a render sequence to present a scene to the viewer.
void wait()
Wait for framerate synch, if a particular framerate was configured on instantiation of the renderer.
byte getPixelFormat()
Get the native pixel format of the renderer which underpins this window.