Unigine::CustomApp Class

Warning

The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.

Header:

#include <UnigineCustomApp.h>

The CustomApp class contains functions to control the Unigine application graphic context, which includes:

Update parameters
Events of the controls (keyboard, mouse)
FPS
Window parameters (height, width, name, etc.)

The class is used when you need to integrate the Unigine engine into a custom application window, it also allows you getting and managing user input.

Usage Example#

The following examples perform:

Changing parameters of the application window (such as title, icon). The specified changes are applied after application start-up. It means that the window with default settings will appear first. If you need the custom settings are applied before the application window is displayed, you should implement your own class inherited from the App class.
Processing user inputs.
Updating the application in background.

Changing Window Parameters#

AppSystemLogic.cpp

Source code (C++)

#include "AppSystemLogic.h"

#include <UnigineCustomApp.h>
#include <UnigineImage.h>

using namespace Unigine;


int AppSystemLogic::init() {

	// set a custom icon for the application window
	ImagePtr icon = Image::create("textures/window_icon.png");
	CustomApp::setIcon(icon->getPixels2D(), icon->getWidth());

	// set a custom title for the application window
	CustomApp::setTitle("Custom Window Title");

	return 1;
}

int AppSystemLogic::update() {
	
	// get an image for the mouse pointer
	ImagePtr mouse = Image::create();
	mouse->load("textures/mouse_pointer.png");
	// resize the image to make it square
	mouse->resize(mouse->getWidth(),mouse->getWidth());
	if (mouse->isLoaded() && mouse->getFormat() == Image::FORMAT_RGBA8)
	{
		// set the image for the OS mouse pointer
		CustomApp::setMouseCursor(mouse->getPixels(), mouse->getWidth());
		// show the OS mouse pointer
		CustomApp::setMouseShow(1);
	}
	
	return 1;
}

Processing User Inputs#

AppWorldLogic.cpp

Source code (C++)

#include "AppWorldLogic.h"

#include <UnigineCustomApp.h>
#include <UnigineEditor.h>
#include <UnigineGame.h>
#include <UnigineGui.h>
#include <UnigineNode.h>
#include <UniginePlayers.h>

using namespace Unigine;

// declare a player pointer
PlayerPersecutorPtr player;

int AppWorldLogic::init() {
	
	// update the application constantly
	CustomApp::setUpdate(1);
	// get a node
	NodePtr node = World::getNodeByName("material_ball");
	// create a new persecutor
	player = PlayerPersecutor::create();
	// set the obtainde node as the target one
	player->setTarget(node);
	// set player's settings
	player->setAnchor(Math::vec3(0, 0, 0.45f));
	player->setPhiAngle(-130.0f);
	player->setMinDistance(0.3f);
	player->setMaxDistance(20.0f);
	player->setDistance(5.0f);
	player->setFov(35.0f);
	// set the player to the Game Camera viewport
	Game::setPlayer(player);

	return 1;
}

int AppWorldLogic::update() {

	// change the distance between the player and the target node on mouse wheel scrolling
	int scroll_delta = CustomApp::getMouseAxis(CustomApp::AXIS_Y);
	if (scroll_delta != 0) {
		float f_scroll_delta = scroll_delta / 30.0f;
		player->setDistance(player->getDistance() - f_scroll_delta);
	}

	// zoom the camera in or out when the right mouse button is pressed and the mouse is moved backward/forward
	if (CustomApp::getMouseButton() == CustomApp::BUTTON_RIGHT) {
		float mouse_delta = (Gui::get()->getMouseDY() + Gui::get()->getMouseDX()) / 500.0f;
		player->setDistance(player->getDistance() - mouse_delta);
	}

	return 1;
}

Methods:

Name	Description View: Sort by:
isActive	Returns the value indicating if the current application is active (i.e. in focus).
isLegacyMode	Returns a value indicating if rendering during the Engine's initialization stage is disabled for the application.
setClipboard	Updates the contents of the system clipboard.
getClipboard	Retrieves the contents of the system clipboard.
getD3D11Context	Returns a pointer to the existing ID3D11DeviceContext interface.
getD3D11Device	Returns a pointer to the existing ID3D11Device interface.
isD3D11Initialized	Returns the status of the Direct3D11 render.
isDone	Returns a value indicating if the application is closed.
setFilter	Filters the FPS counter value.
getFlags	Returns the video mode flags set for the application.
getFps	Returns the application FPS counter value.
getMinFps	Returns the minimum FPS counter value for the last 600 frames.
getMaxFps	Returns the maximum FPS counter value for the last 600 frames.
getMeanFps	Returns the average FPS counter value for the last 600 frames.
getFTime	Returns time spent between the previous update and the current one.
setGamma	Sets the gamma correction value.
isGLInitialized	Returns the status of the OpenGL renderer.
getHandle	Returns a pointer to the application handle.
setHeight	Sets the new height for the application window.
getHeight	Returns the current height of the application window.
setIcon	Sets an icon for the application window.
getIFps	Returns an inverse value of the application FPS counter.
getKeyName	Returns a name of the given key.
setKeyState	Sets the keyboard key state (pressed or not pressed).
getKeyState	Returns the keyboard key state (pressed or not pressed).
setMouse	Sets a mouse pointer to the specified position in the coordinate system of the application window.
setMouseAxis	Sets the mouse wheel delta along the specified axis.
getMouseAxis	Returns the current mouse wheel delta along the specified axis.
setMouseButton	Simulates pressing of the specified mouse buttons.
getMouseButton	Returns the current states of all mouse buttons.
getMouseButtonName	Returns a name of the given button.
getMouseButtonState	Returns a state of the specified button (pressed or not pressed).
setMouseCursor	Sets a custom image for the OS mouse cursor.
setMouseGrab	Sets a value indicating if the mouse pointer is bound to the application window.
getMouseGrab	Returns a value indicating if the mouse pointer is bound to the application window.
setMouseShow	Sets a value indicating if the OS mouse pointer should be displayed.
getMouseShow	Returns a value indicating if the OS mouse pointer is displayed.
getMouseX	Returns the current X coordinate of the mouse pointer in the coordinate system of the application window.
getMouseY	Returns the current Y coordinate of the mouse pointer in the coordinate system of the application window.
getName	Returns a name of the graphics API used for application rendering.
isNULLInitialized	Returns a value indicating whether the NULL renderer is initialized.
getNumTouches	Returns the number of touches.
setPosition	Sets the window position.
getPositionX	Returns the X coordinate of the upper-left corner of the window.
getPositionY	Returns the Y coordinate of the upper-left corner of the window.
setTitle	Sets a title for the application window.
getTouchX	Returns the X coordinate of the touch in the coordinate system of the application window.
getTouchY	Returns the Y coordinate of the touch in the coordinate system of the application window.
setUpdate	Sets the value indicating whether the application widow is updated when the window is hidden or out of focus (rendering frames in background).
getUpdate	Returns the current window update mode (the value indicating whether the application is updated when the window is hidden).
setVideoMode	Sets a video mode and initializes the application.
getVideoModeName	Returns the name of the current video mode.
setWidth	Sets the new width of the application window.
getWidth	Returns the current application window width.
buttonPress	Application notifies the engine that the specified mouse button is pressed.
buttonRelease	Application notifies the engine that the specified mouse button is released.
clearKeyState	Returns the key state and clears it to 0 (not pressed).
clearMouseAxis	Returns the current mouse wheel position delta and clears it to 0.
clearMouseButtonState	Returns the button state and clears it to 0 (not pressed).
dialogFile	Creates a system modal file dialog.
dialogMessage	Creates a system modal message dialog.
doRender	The engine requests to call the render() function.
doSwap	The engine requests to call the swap() function.
doUpdate	The engine requests to call the update() function.
exit	The engine requests to exit the application.
initD3D11	Initializes the Direct3D11 render.
initGL	Initializes the OpenGL render.
initNULL	Initializes the NULL renderer: nothing is rendered onto the screen.
keyPress	Application notifies the engine that the specified key on a keyboard is pressed.
keyPressUnicode	Application notifies the engine that the specified key is pressed.
keyRelease	Application notifies the engine that the specified key on a keyboard is released.
render	Application requests the engine to render.
shutdownD3D11	Shuts down the Direct3D11 render.
shutdownGL	Shuts down the OpenGL render.
shutdownNULL	Shuts down the NULL renderer.
startFps	Starts the FPS counter if it was stopped.
stopFps	Stops the FPS counter.
swap	Application requests the engine to swap.
update	Application requests the engine to update.
createContext	Creates a rendering context depending on the graphics API used for application rendering.
initGLContext	Initializes an OpenGL rendering context.
initD3D11Context	Initializes a D3D11 rendering context.
getGLContext	Returns the pointer to the OpenGL context.
getGLVersionMajor	Returns the major version number of the supported OpenGL API.
getGLVersionMinor	Returns the minor version number of the supported OpenGL API.
setCustomSwapBuffersCallback	Sets a callback to subscribe for an event to take place instead of swapping from the back buffer to the front one.
getCustomSwapBuffersCallback	Returns the current buffer swap callback function set for the application.

Variables:

Name	Description
AXIS_X = 0	A mouse wheel is scrolled horizontally (along the X axis; a horizontal mouse wheel is required).
AXIS_Y = 0	A mouse wheel is scrolled vertically (along the Y axis; a vertical mouse wheel is used).
BREAK_ON_ERROR = 0	Break if an error occurs.
BUTTON_AUX_0 = 0	Detected activity of the first auxiliary mouse button.
BUTTON_AUX_1 = 0	Detected activity of the second auxiliary mouse button.
BUTTON_AUX_2 = 0	Detected activity of the third auxiliary mouse button.
BUTTON_AUX_3 = 0	Detected activity of the fourth auxiliary mouse button.
BUTTON_DCLICK = 0	Left mouse button is double-clicked.
BUTTON_LEFT = 0	Detected activity of the left mouse button.
BUTTON_MIDDLE = 0	Detected activity of the middle mouse button (scrolling wheel).
BUTTON_RIGHT = 0	Detected activity of the right mouse button.
DEBUG_CONTEXT = 0	Debug context is enabled.
DESTROY = 0	Fullscreen mode is destroyed.
FULLSCREEN = 0	Fullscreen mode.
FULLWINDOW = 0	Full window mode.
KEY_ALT = 0	The ALT key is pressed.
KEY_BACKSPACE = 0	The Backspace key is pressed.
KEY_CAPS = 0	The Caps Lock key is pressed.
KEY_CMD = 0	The Command key is pressed (for OS X).
KEY_CTRL = 0	The Ctrl key is pressed.
KEY_DELETE = 0	The Delete key is pressed.
KEY_DOWN = 0	The Down Arrow key is pressed.
KEY_END = 0	The End key is pressed.
KEY_ESC = 0	The Esc key is pressed.
KEY_F1 = 0	The F1 key is pressed.
KEY_F10 = 0	The F10 key is pressed.
KEY_F11 = 0	The F11 key is pressed.
KEY_F12 = 0	The F12 key is pressed.
KEY_F2 = 0	The F2 key is pressed.
KEY_F3 = 0	The F3 key is pressed.
KEY_F4 = 0	The F4 key is pressed.
KEY_F5 = 0	The F5 key is pressed.
KEY_F6 = 0	The F6 key is pressed.
KEY_F7 = 0	The F7 key is pressed.
KEY_F8 = 0	The F8 key is pressed.
KEY_F9 = 0	The F9 key is pressed.
KEY_HOME = 0	The Home key is pressed.
KEY_INSERT = 0	The Insert key is pressed.
KEY_LEFT = 0	The Left Arrow key is pressed.
KEY_NUM = 0	The Num Lock key is pressed.
KEY_PGDOWN = 0	The Page Down key is pressed.
KEY_PGUP = 0	The Page Up key is pressed.
KEY_RETURN = 0	The Enter (Return) key is pressed.
KEY_RIGHT = 0	The Right Arrow key is pressed.
KEY_SCROLL = 0	The Scroll Lock key is pressed.
KEY_SHIFT = 0	The Shift key is pressed.
KEY_TAB = 0	The Tab key is pressed.
KEY_UP = 0	The Page Up key is pressed.
NUM_AXES = 0	Number of axes, along which a mouse wheel can be scrolled.
NUM_KEYS = 0	Detected number of keyboard keys.
NUM_TOUCHES = 0	Number of the detached touches (for touch-screen controls).
RESIZABLE = 0	Resizable window.
VSYNC = 0	Vertical synchronization.
QUAD_BUFFER_CONTEXT = 0	Quad buffer context is enabled.
INDEPENDENT_SIZE_WINDOW = 0	Window size is independent of rendering resolution.

App Class

Members

int isActive ( ) #

Returns the value indicating if the current application is active (i.e. in focus). The function will always return 1, if the window update mode is set to 1.

NoticeThe sounds will be automatically disabled, if the application is not active.

Return value

1 if application is active; otherwise, 0.

int isLegacyMode ( ) const#

Returns a value indicating if rendering during the Engine's initialization stage is disabled for the application. Engine's boot screen requires rendering to be performed at the Engine's initialization stage. Certain applications do not support rendering in the init() by design. To ensure stable operation for such apps you can disable render-during-init functionality by setting the legacy mode. Thus, the boot screen won't be displayed for these applications.

Return value

1 if rendering during the Engine's initialization stage is disabled for the application; otherwise, 0.

void setClipboard ( const char * str ) #

Updates the contents of the system clipboard.

Arguments

const char * str - Contents to set.

const char * getClipboard ( ) #

Retrieves the contents of the system clipboard.

Return value

Contents of the system clipboard.

void * getD3D11Context ( ) #

Returns a pointer to the existing ID3D11DeviceContext interface.

void * getD3D11Device ( ) #

Returns a pointer to the existing ID3D11Device interface.

Return value

ID3D11Device interface pointer.

int isD3D11Initialized ( ) #

Returns the status of the Direct3D11 render.

Return value

1 if the render is initialized; otherwise, 0.

int isDone ( ) #

Returns a value indicating if the application is closed.

Return value

1 if the application is closed; otherwise, 0.

void setFilter ( float filter ) #

Filters the FPS counter value. By the value of 0, filtering is disabled and the current FPS value is always shown. The default is 0.9f (10 percent of the current FPS is taken into account).

Arguments

float filter - Filter value in range [0;1). The default value is 0.9f (10 percent of the current FPS is taken into account).

int getFlags ( ) #

Returns the video mode flags set for the application.

Return value

Video mode flags: DESTROY, RESIZABLE, FULLSCREEN, etc.

float getFps ( ) #

Returns the application FPS counter value.

Return value

Application FPS counter value.

float getMinFps ( ) #

Returns the minimum FPS counter value for the last 600 frames.

Return value

Minimum FPS counter value for the last 600 frames.

float getMaxFps ( ) #

Returns the maximum FPS counter value for the last 600 frames.

Return value

Maximum FPS counter value for the last 600 frames.

float getMeanFps ( ) #

Returns the average FPS counter value for the last 600 frames.

Return value

Average FPS counter value for the last 600 frames.

float getFTime ( ) #

Returns time spent between the previous update and the current one.

Return value

Application frame duration in seconds.

int setGamma ( float gamma ) #

Sets the gamma correction value.

Arguments

float gamma - Gamma correction value. If the 1.0f value is provided, no gamma correction is applied.

Return value

1 if the gamma correction value is set successfully; otherwise, 0.

int isGLInitialized ( ) #

Returns the status of the OpenGL renderer.

Return value

1 if the OpenGL render is initialized; otherwise, 0.

void * getHandle ( ) #

Returns a pointer to the application handle.

Return value

Pointer to the application handle.

void setHeight ( int value ) #

Sets the new height for the application window. The height is specified for the window inside and doesn't include the window borders.

Notice

If the INDEPENDENT_SIZE_WINDOW flag is set, only render resolution will be changed, leaving the window size unaffected.

Arguments

int value - Application window height, in pixels.

int getHeight ( ) #

Returns the current height of the application window. The returned value is the window inside height without borders.

Return value

Current height of the application window, in pixels.

int setIcon ( uchar[] data, int data_size ) #

Sets an icon for the application window. The image must be of the square size and RGBA8 format.

Source code (C++)

// create an instance of the Image class
ImagePtr icon = Image::create("window_icon.png");
// set the image as an icon of the application window
App::setIcon(icon->getPixels2D(), icon->getWidth());

Arguments

uchar[] data - Icon resource data.
int data_size - Resourse size.

Return value

1 if the icon is set successfully; otherwise, 0.

float getIFps ( ) #

Returns an inverse value of the application FPS counter.

Return value

Inverse value of the application FPS counter (1/FPS).

const char * getKeyName ( int key ) #

Returns a name of the given key.

Source code (C++)

Log::message("getKeyName() returned: %s\n", App::getKeyName(App::KEY_ALT));
Log::message("getKeyName() returned: %s\n", App::getKeyName(97));

Output

getKeyName() returned: ALT
getKeyName() returned: a

Arguments

int key - Key in one of the following formats:
- Character format (for example, 'a')
- Standard ASCII key code (for example, 97)
- One of KEY_* variables

Return value

Key name.

void setKeyState ( int key, int state ) #

Sets the keyboard key state (pressed or not pressed).

Source code (C++)

// set the ALT button pressed
App::setKeyState(App::KEY_ALT, 1);
// set the 'a' button pressed
App::setKeyState(97, 1);

Arguments

int key - Key ID. Possible values can be in range [0;255], which are standard ASCII code symbols, or in range [KEY_ESC;KEY_F12], which are used for control buttons. For full list of control buttons see KEY_* variables.
int state - Key state: 1 to set the button pressed; 0 to set the button not pressed.

int getKeyState ( int key ) #

Returns the keyboard key state (pressed or not pressed).

Source code (C++)

if (App::getKeyState(App::KEY_ALT)) Log::message("ALT has been pressed\n");
if (App::getKeyState(97)) Log::message("'a' has been pressed\n");

Arguments

int key - Key ID. Possible values can be in range [0;255], which are standard ASCII code symbols, or in range [KEY_ESC;KEY_F12], which are used for control buttons. For full list of control button see KEY_* variables.

Return value

1 if the key is pressed; otherwise, 0.

void setMouse ( int x, int y ) #

Sets a mouse pointer to the specified position in the coordinate system of the application window.

Source code (C++)

// set a position of the mouse pointer
int mouse_x = App::getWidth() / 2;
int mouse_y = App::getHeight() / 2;

// set the mouse pointer to the position on pressing Esc
if (App::clearKeyState(App::KEY_ESC))
{
	// check if the mouse pointer is bound to the application window
	if (App::getMouseGrab())
		// set the pointer to the position
		App::setMouse(mouse_x, mouse_y);
}

Arguments

int x - X coordinate of the mouse pointer.
int y - Y coordinate of the mouse pointer.

void setMouseAxis ( int axis, int value ) #

Sets the mouse wheel delta along the specified axis. The delta value is changed when scrolling the mouse wheel horizontally (APP_AXIS_X) or vertically (APP_AXIS_Y).

Arguments

int axis - Mouse axis. Possible values are AXIS_X, AXIS_Y.
int value - Mouse wheel delta.

int getMouseAxis ( int axis ) #

Returns the current mouse wheel delta along the specified axis. The delta value is changed when scrolling the mouse wheel horizontally (AXIS_X) or vertically (AXIS_Y).

Source code (C++)

int axis_x = App::getMouseAxis(App::AXIS_X);
int axis_y = App::getMouseAxis(App::AXIS_Y);
if(axis_x > 0) Log::message("Mouse wheel has been scrolled right\n");
if(axis_x < 0) Log::message("Mouse wheel has been scrolled left\n");
if(axis_y > 0) Log::message("Mouse wheel has been scrolled up\n");
if(axis_y < 0) Log::message("Mouse wheel has been scrolled down\n");

Arguments

int axis - Mouse axis. Possible values are AXIS_X, AXIS_Y.

Return value

Mouse wheel delta regarding the last wheel position.

void setMouseButton ( int button ) #

Simulates pressing of the specified mouse buttons.

Source code (C++)

// set the right and middle mouse buttons pressed in addition to already pressed buttons
App::setMouseButton(App::getMouseButton() | App::BUTTON_RIGHT | App::BUTTON_MIDDLE);

Arguments

int button - Mouse buttons to be pressed. Possible values are BUTTON_*.

int getMouseButton ( ) #

Returns the current states of all mouse buttons. Each bit of the returned bit mask will specify the state of the buttons in the following order:

BUTTON_LEFT = 1 << 0
BUTTON_MIDDLE
BUTTON_RIGHT
BUTTON_DCLICK
BUTTON_AUX_0
BUTTON_AUX_1
BUTTON_AUX_2
BUTTON_AUX_3

Return value

A bit mask that stores current states of all mouse buttons (pressed or not pressed).

const char * getMouseButtonName ( int button ) #

Returns a name of the given button.

Arguments

int button - One of BUTTON_* variables.

Return value

Button name.

int getMouseButtonState ( int button ) #

Returns a state of the specified button (pressed or not pressed). If several buttons are specified, the function will return the state of the first pressed button (if any); if no buttons are pressed, the function will return 0.

Source code (C++)

if (App::getMouseButtonState(App::BUTTON_LEFT | App::BUTTON_DCLICK)) Log::message("Left mouse button has been clicked\n");
if (App::getMouseButtonState(App::BUTTON_MIDDLE)) Log::message("Middle mouse button has been clicked\n");

Arguments

int button - One of BUTTON_* variables

Return value

1 if al least one of the specified buttons is pressed; otherwise, 0.

int setMouseCursor ( uchar[] data, int x = 0, int y = 0 ) #

Sets a custom image for the OS mouse cursor. The image must be of the square size and RGBA8 format.

Source code (C++)

// create an instance of the Image class
ImagePtr cursor = Image::create("textures/my_cursor.png");
// set the image as the mouse cursor
App::setMouseCursor(icon->getPixels2D(), icon->getWidth());
// show the OS mouse pointer
App::setMouseShow(1);

Arguments

uchar[] data - Cursor image data.
int x - X coordinate of the cursor's hot spot.
int y - Y coordinate of the cursor's hot spot.

Return value

1 if the image is set successfully; otherwise, 0.

void setMouseGrab ( int grab ) #

Sets a value indicating if the mouse pointer is bound to the application window.

Arguments

int grab - 1 if the mouse cannot leave the application window; otherwise, 0.

int getMouseGrab ( ) #

Returns a value indicating if the mouse pointer is bound to the application window.

Return value

1 if the mouse pointer cannot leave the application window; otherwise, 0.

void setMouseShow ( int show ) #

Sets a value indicating if the OS mouse pointer should be displayed.

Arguments

int show - 1 if the OS mouse pointer should be displayed; 0 if the application cursor is used only.

int getMouseShow ( ) #

Returns a value indicating if the OS mouse pointer is displayed.

Return value

1 if the OS mouse pointer is displayed; otherwise, 0.

int getMouseX ( ) #

Returns the current X coordinate of the mouse pointer in the coordinate system of the application window.

Return value

X coordinate of the mouse pointer.

int getMouseY ( ) #

Returns the current Y coordinate of the mouse pointer in the coordinate system of the application window.

Return value

Y coordinate of the mouse pointer.

const char * getName ( ) #

Returns a name of the graphics API used for application rendering.

Return value

One of the following values:

opengl for OpenGL
direct3d11 for DirectX 11
NULL if no graphics API is used for application rendering

int isNULLInitialized ( ) #

Returns a value indicating whether the NULL renderer is initialized.

Return value

1 if the renderer is initialized; otherwise, 0.

int getNumTouches ( ) #

Returns the number of touches. The maximum number of touches is 16.

Return value

Number of touches.

int setPosition ( int x, int y ) #

Sets the window position.

Arguments

int x - X coordinate of the upper-left corner of the window.
int y - Y coordinate of the upper-left corner of the window.

Return value

1 if the position of the window is set successfully; otherwise, 0.

int getPositionX ( ) #

Returns the X coordinate of the upper-left corner of the window.

Return value

X coordinate of the upper-left corner of the window.

int getPositionY ( ) #

Returns the Y coordinate of the upper-left corner of the window.

Return value

Y coordinate of the upper-left corner of the window.

int setTitle ( const char * title ) #

Sets a title for the application window.

Arguments

const char * title - Window title.

Return value

1 if the title is set successfully; otherwise, 0.

int getTouchX ( int touch ) #

Returns the X coordinate of the touch in the coordinate system of the application window.

Arguments

int touch - The touch number.

Return value

X coordinate of the touch.

int getTouchY ( int touch ) #

Returns the Y coordinate of the touch in the coordinate system of the application window.

Arguments

int touch - The toucn number.

Return value

Y coordinate of the touch.

int setUpdate ( int update ) #

Sets the value indicating whether the application widow is updated when the window is hidden or out of focus (rendering frames in background). By default your UNIGINE application stops rendering frames and updating its main window, when it window goes out of focus (e.g. user switches to another window). Setting the update mode to 1 enables constant rendering regardless of whether the application window is focused or in the background.

Arguments

int update - Window update mode: 1 for constantly repeating update cycle (i.e. the application is updated if the window is hidden or out of focus); otherwise, 0.

Return value

1 if the window update mode is set successfully; otherwise, 0.

int getUpdate ( ) #

Returns the current window update mode (the value indicating whether the application is updated when the window is hidden).

Return value

1 if the update cycle is constantly repeated; otherwise, 0.

int setVideoMode ( int width, int height, int flags = 0, int refresh = 0 ) #

Sets a video mode and initializes the application.

Arguments

int width - Video width in pixels.
int height - Video height in pixels.
int flags - Video mode flags: DESTROY, RESIZABLE, FULLSCREEN, FULLWINDOW, VSYNC, DEBUG_CONTEXT, BREAK_ON_ERROR.
int refresh - Force the refresh rate in Hz; if 0 is provided, the default refresh rate is used.

Return value

1 if the video mode is set and the application is initialized successfully; otherwise, 0.

const char * getVideoModeName ( ) #

Returns the name of the current video mode.

Return value

Returns the name of the current video mode.

void setWidth ( int value ) #

Sets the new width of the application window. The width is specified for the window inside part and doesn't include the window borders.

Notice

If the INDEPENDENT_SIZE_WINDOW flag is set, only render resolution will be changed, leaving the window size unaffected.

Arguments

int value - Window width, in pixels.

int getWidth ( ) #

Returns the current application window width. The returned value is the window inside part width without borders.

Return value

Window width, in pixels.

void buttonPress ( int button ) #

Application notifies the engine that the specified mouse button is pressed.

Arguments

int button - One of the BUTTON_* variables.

void buttonRelease ( int button ) #

Application notifies the engine that the specified mouse button is released.

Arguments

int button - One of the BUTTON_* variables.

int clearKeyState ( int key ) #

Returns the key state and clears it to 0 (not pressed). This function allows returning the key state only once even if it is kept pressed over several frames.

Arguments

int key - Key ID. Possible values can be in range [0;255], which are standard ASCII code symbols, or in range [KEY_ESC;KEY_F12], which are used for control buttons. For full list of control buttons see KEY_* variables.

Return value

1 if the key is pressed, and this function was not called previously in the current frame; otherwise, 0.

int clearMouseAxis ( int axis ) #

Returns the current mouse wheel position delta and clears it to 0.

Arguments

int axis - Mouse wheel axis. Possible values are AXIS_X, AXIS_Y.

Return value

Mouse wheel delta regarding the last mouse wheel position.

int clearMouseButtonState ( int button ) #

Returns the button state and clears it to 0 (not pressed). This function allows returning the button state only once even if it is kept pressed over several frames. The function will return 1 if at least one of the specified buttons is pressed.

Source code (C++)

// the function will return 1 if one of the buttons is pressed;
// the button state will be set to 0
App::clearMouseButtonState(App::BUTTON_LEFT | App::BUTTON_RIGHT);

Arguments

int button - Button. Possible values are BUTTON_*.

Return value

1 if at least one of the buttons is pressed, and this function was not called previously in the current frame; otherwise, 0.

int dialogFile ( const char * title, char * name, int size, const char * filter = 0, const char * flags = 0 ) #

Creates a system modal file dialog. Since the dialog is modal, all other actions are stopped until this function returns a value.

Arguments

const char * title - Title of the dialog window.
char * name - Current file name.
int size - Size of the name buffer.
const char * filter - File extension filter. Accepts dot-separated file extensions, for example: ".tga.jpg.png.tif.psd".
const char * flags - File dialog flags. Accepts a string: "o" - open file dialog; "s" - save file dialog; "d" - directory dialog.

Return value

1 if the OK button is pressed; 0 if the Cancel button is pressed.

int dialogMessage ( const char * title, const char * str, const char * flags = 0 ) #

Creates a system modal message dialog. Since the dialog is modal, all other actions are stopped until this function returns a value.

Notice

If you don't specify flags, the Oc combination will be used by default.

Arguments

const char * title - Title of the dialog window.
const char * str - Content of the dialog window.
const char * flags - Dialog window flags. The argument accepts a string with names of buttons. The following combinations are available:
- Oc or oC - OK, Cancel.
- Yn or yN - Yes, No
- ynC, yNc or Ync - Yes, No, Cancel
Notice
The uppercase letter indicates which button will be in focus.
If you send any other combination, only the OK button will appear in the window.

Return value

The function returns one of the following values:

1 if the OK button has been pressed.
2 if the Yes button has been pressed.
-1 if the No button has been pressed.
0 if the Cancel button has been pressed.

void doRender ( ) #

The engine requests to call the render() function. The application can ignore this request if it handles the main loop by itself.

void doSwap ( ) #

The engine requests to call the swap() function. The application can ignore this request if it handles the main loop by itself.

void doUpdate ( ) #

The engine requests to call the update() function. Application can ignore this request if it handles the main loop by itself.

void exit ( ) #

The engine requests to exit the application.

int initD3D11 ( void * adapter, void * device, void * context, int debug = 0 ) #

Initializes the Direct3D11 render. This function should be called when the Direct3D11 device is ready for rendering.

Arguments

void * adapter - Pointer to the IDXGIAdapter interface.
void * device - Pointer to the ID3D11Device interface.
void * context - Pointer to ID3D11DeviceContext interface.
int debug - Debug output flag. Use 1 to enable debug output, 0 to disable it.

Return value

1 if the Direct3D11 render is initialized successfully; otherwise, 0.

int initGL ( void * context, int debug = 0 ) #

Initializes the OpenGL render. This function should be called when OpenGL context is created.

Arguments

void * context - Pointer to OpenGL Context interface.
int debug - Debug output flag. Use 1 to enable debug output, 0 to disable it.

Return value

1 if the render is initialized successfully; otherwise, 0.

int initNULL ( ) #

Initializes the NULL renderer: nothing is rendered onto the screen. This mode is used, for example, for servers in case of playing over the network.

Return value

1 if the renderer is initialized successfully; otherwise, 0.

void keyPress ( unsigned int key ) #

Application notifies the engine that the specified key on a keyboard is pressed.

Arguments

unsigned int key - Key ID. Possible values can be in range [0;255], which are standard ASCII code symbols, or in range [KEY_ESC;KEY_F12], which are used for control buttons. For full list of control buttons see KEY_* variables.

void keyPressUnicode ( unsigned int key ) #

Application notifies the engine that the specified key is pressed.

Arguments

unsigned int key - Unicode symbol.

void keyRelease ( unsigned int key ) #

Application notifies the engine that the specified key on a keyboard is released.

Arguments

unsigned int key - Key ID. Possible values can be in range [0;255], which are standard ASCII code symbols, or in range [KEY_ESC;KEY_F12], which are used for control buttons. For full list of control buttons see KEY_* variables.

void render ( ) #

Application requests the engine to render.

int shutdownD3D11 ( ) #

Shuts down the Direct3D11 render. This function should be called when the Direct3D11 device is released.

Return value

1 if the Direct3D11 render is shut down successfully; otherwise, 0.

int shutdownGL ( ) #

Shuts down the OpenGL render. This function should be called when OpenGL context is destroyed.

Return value

1 if the render is shut down successfully; otherwise, 0.

int shutdownNULL ( ) #

Shuts down the NULL renderer.

Return value

1 if the renderer is shut down successfully; otherwise, 0.

void startFps ( ) #

Starts the FPS counter if it was stopped. All function calls are placed into a stack, so the number of calls to this function should correspond to the number of calls to the stopFps() function.

void stopFps ( ) #

Stops the FPS counter. This function should be called if application window is hidden or some heavy non-rendering tasks are processing. All function calls are placed into a stack, so the number of calls to this function should correspond to the number of calls to the startFps() function.

void swap ( ) #

Application requests the engine to swap.

void update ( ) #

Application requests the engine to update.

Ptr<RenderContext> createContext ( ) #

Creates a rendering context depending on the graphics API used for application rendering.

Return value

RenderContext smart pointer.

Ptr<RenderContext> initGLContext ( ) #

Initializes an OpenGL rendering context.

Return value

RenderContext smart pointer.

Ptr<RenderContext> initD3D11Context ( ) #

Initializes a D3D11 rendering context.

Return value

RenderContext smart pointer.

void * getGLContext ( ) #

Returns the pointer to the OpenGL context.

Return value

OpenGL context pointer.

int getGLVersionMajor ( ) #

Returns the major version number of the supported OpenGL API.

Return value

OpenGL API major version number.

int getGLVersionMinor ( ) #

Returns the minor version number of the supported OpenGL API.

Return value

OpenGL API minor version number.

void setCustomSwapBuffersCallback ( CallbackBase * callback ) #

Sets a callback to subscribe for an event to take place instead of swapping from the back buffer to the front one. So you can add your custom logic just before, right after or even instead of the buffer swap operation. The callback signature is as follows:

Source code

void CallbackMethod(void *arg1, void *arg2, void *arg3)

Logic of these three pointers is determined by the current graphics API:

DirectX on Windows: arg1 - ID3D11Device, arg2 - ID3D11DeviceContext, arg3 - IDXGISwapChain
OpenGL on Windows: arg1 - HDC
OpenGL on Linux: arg1 - Display, arg2 - GLXDrawable

Here is an example that uses VSync even if -video_vsync 0:

Custom Swap Buffer Logic Example

Source code (C++)

void custom_swap_buffers(void *arg1, void *arg2, void *arg3)
{
	if (Render::getAPI() == Render::API_DIRECT3D11)
	{
		#ifdef _WIN32
		ID3D11Device *device = static_cast<ID3D11Device *>(arg1);
		ID3D11DeviceContext *context = static_cast<ID3D11DeviceContext *>(arg2);
		IDXGISwapChain *swap_chain = static_cast<IDXGISwapChain *>(arg3);

		swap_chain->Present(1, 0);
		#endif
	}
	else if (Render::getAPI() == Render::API_OPENGL)
	{
		#ifdef _WIN32
		hdc = static_cast<HDC>(arg1);
		#else
		display = static_cast<Display *>(arg1);
		drawable = *static_cast<GLXDrawable *>(arg2);
		#endif

		#ifdef _WIN32
		wglSwapIntervalEXT(1);
		SwapBuffers(hdc);
		#else
		glXSwapIntervalEXT(display, drawable, 1);
		glXSwapBuffers(display, drawable);
		#endif
	}
}

Arguments

CallbackBase * callback - Callback pointer.

CallbackBase * getCustomSwapBuffersCallback ( ) #

Returns the current buffer swap callback function set for the application.

Return value

Callback pointer.

Last update: 2020-11-24

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::CustomApp Class

Usage Example#

Changing Window Parameters#

Processing User Inputs#

See Also#

Methods:

Variables:

App Class

Members

int isActive ( ) #

Return value

int isLegacyMode ( ) const#

Return value

void setClipboard ( const char * str ) #

Arguments

const char * getClipboard ( ) #

Return value

void * getD3D11Context ( ) #

void * getD3D11Device ( ) #

Return value

int isD3D11Initialized ( ) #

Return value

int isDone ( ) #

Return value

void setFilter ( float filter ) #

Arguments

int getFlags ( ) #

Return value

float getFps ( ) #

Return value

float getMinFps ( ) #

Return value

float getMaxFps ( ) #

Return value

float getMeanFps ( ) #

Return value

float getFTime ( ) #

Return value

int setGamma ( float gamma ) #

Arguments

Return value

int isGLInitialized ( ) #

Return value

void * getHandle ( ) #

Return value

void setHeight ( int value ) #

Arguments

int getHeight ( ) #

Return value

int setIcon ( uchar[] data, int data_size ) #

Arguments

Return value

float getIFps ( ) #

Return value

const char * getKeyName ( int key ) #

Arguments

Return value

void setKeyState ( int key, int state ) #

Arguments

int getKeyState ( int key ) #

Arguments

Return value

void setMouse ( int x, int y ) #

Arguments

void setMouseAxis ( int axis, int value ) #

Arguments

int getMouseAxis ( int axis ) #

Arguments

Return value

void setMouseButton ( int button ) #

Arguments

int getMouseButton ( ) #

Return value

const char * getMouseButtonName ( int button ) #

Arguments

Return value

int getMouseButtonState ( int button ) #

Arguments

Return value

int setMouseCursor ( uchar[] data, int x = 0, int y = 0 ) #