Unigine.Viewport Class

Sort by:

List of functions:

A Viewport class is used to render a scene with the specified settings.

There are two main use cases of the Viewport class:

Integrate the engine to a 3rd party renderer (or vice versa) and render the image anywhere (via the render() method): to the external library, App interface, TextureRender interface (a frame buffers abstraction), etc.

To render the image to the TextureRender interface, do the following:

Source code (C#)

// mono rendering
// initialization
Viewport viewport = new Viewport();

TextureRender texturerender = new TextureRender();
Texture texture = new Texture();
texture.create2D(512,512,Texture.FORMAT_RGBA8,Texture.USAGE_RENDER); // create 512 x 512 render target

Camera camera = new Camera();
// set modelview & projection matrices to camera instance

// rendering
texturerender.enable();
	texturerender.setColorTexture(0,texture);
	viewport.render(camera);
texturerender.disable();

To render the image to the TextureRender interface in the stereo mode, do the following:

Source code (C#)

// stereo rendering
// initialization
Viewport viewport = new Viewport();

TextureRender texturerender = new TextureRender();
Texture left_texture = new Texture();
Texture right_texture = new Texture();

// create two 512 x 512 render target for each eye
left_texture.create2D(512,512,Texture.FORMAT_RGBA8,Texture.USAGE_RENDER);
right_texture.create2D(512,512,Texture.FORMAT_RGBA8,Texture.USAGE_RENDER);

Camera left_eye = new Camera();
Camera right_eye = new Camera();
// set modelview & projection matrices for each eyes

// rendering
texturerender.enable();
	texturerender.setColorTexture(0,left_texture);
	texturerender.setColorTexture(0,right_texture);
	viewport.renderStereo(left_eye,right_eye,"post_stereo_separate"); // use "post_stereo_separate" material in order to render to both textures
texturerender.disable();

To render the image to the App interface, check the following 3rdparty samples (e.g. source -> samples -> 3rdparty -> ViewportQt )
Notice
Qml and ViewportQt samples are available only for the Engineering and Sim editions of UNIGINE SDKs.

Render a scene to the image (data will be transfered from GPU memory to CPU memory) or texture (data stays in the GPU memory).

To render the scene to the Texture interface, use the renderTexture2D(camera,texture) method.

Source code (C#)

// initialization
Viewport viewport = new Viewport();

Texture texture = new Texture();
texture.create2D(512,512,Texture.FORMAT_RGBA8,Texture.USAGE_RENDER); // create 512 x 512 render target

CameraPtr camera = new Camera();
// set modelview & projection matrices to camera instance

// rendering
RenderState render_state = RenderState.get();

// saving current render state and clearing it 
render_state.saveState();
render_state.clearStates();
		
// rendering an image from the camera to the texture
viewport.renderTexture2D(camera, texture);

// restoring back render state
render_state.restoreState();

To render the scene to the Image interface, use the following methods:

Render a node to the image (data will be transfered from GPU memory to CPU memory) or texture (data stays in the GPU memory).
- To render the node to the Texture interface, use the renderNodeTexture2D(camera,node,texture) method.
- To render the node to the Image interface, use the following methods:

Notice

To set any viewport as a main, use the setViewport() method of the Render class.

A single viewport should be used with a single camera, otherwise it may cause visual artefacts. To avoid artefacts, when using several cameras with a single viewport, all post effects must be disabled using the setSkipFlags() method with the SKIP_POSTEFFECTS flag.

Viewport Class

Members

static Viewport()

Creates a new viewport with default settings.

void setAspectCorrection(int correction)

Sets the aspect correction for current viewport. 1 enables correction, 0 disables.

Arguments

int correction - 1 to enable aspect correction, 0 to disable.

int getAspectCorrection()

Return the value indicating if the aspect correction enabled for current viewport.

Return value

1 if the aspect correction enabled, otherwise 0.

int addCallback(int callback, Unigine::CallbackBase * func)

Adds a callback for the specified stage of the rendering sequence. Callback functions can be used to get access to buffers and matrices at intermediate stages of the rendering sequence. Some of them are read-only, but most of them can be modified ad hoc.Callback function must be as follows:

Source code (C#)

void callback_name(Renderer renderer){

	/* .. */
	
}

Arguments

int callback - Stage of the rendering sequence for which a callback is to be added. One of the Render.CALLBACK_* variables.
Notice
The _BEGIN prefix corresponds to the beginning of the rendering pass, _END - to its completion.
Unigine::CallbackBase * func - Callback pointer.

Return value

Number of the last added callback of the specified type, if the callback was added successsfully; otherwise, -1.

void clearCallbacks(int callback)

Clears all added callbacks for the specified stage of the rendering sequence. Callback functions can be used to get access to buffers and matrices at intermediate stages of the rendering sequence. Some of them are read-only, but most of them can be modified ad hoc.

Arguments

int callback - Stage of the rendering sequence for which the callbacks are to be cleared. One of the Render.CALLBACK_* variables.
Notice
The _BEGIN prefix corresponds to the beginning of the rendering pass, _END - to its completion.

void removeCallback(int callback, int num)

Removes a callback with a given number from the list of callbacks for the specified stage of the rendering sequence. Callback functions can be used to get access to buffers and matrices at intermediate stages of the rendering sequence. Some of them are read-only, but most of them can be modified ad hoc.

Arguments

int callback - Stage of the rendering sequence for which the callback is to be removed. One of the Render.CALLBACK_* variables.
Notice
The _BEGIN prefix corresponds to the beginning of the rendering pass, _END - to its completion.
int num - Callback number.

void setFirstFrame(int frame)

Sets a value indicating if the first frame should be enabled over the current frame.

Arguments

int frame - 1 to set the first frame flag; otherwise, 0.

int getFirstFrame()

Returns a value indicating if the first frame is enabled over the current frame.

Return value

1 if the first frame flag is set; otherwise, 0.

int getID()

Returns the viewport ID.

Return value

Viewport ID.

void setMode(int mode)

Sets the rendering mode for the current viewport. It can be one of the stereo or panoramic modes or the default mode.

Arguments

int mode - A rendering mode.

int getMode()

Returns the rendering mode set for the current viewport. It can be one of the stereo or panoramic modes or the default mode.

Return value

The current rendering mode.

void setNodeEnvironmentTextureName(string name)

Sets a name for the environment texture.

Arguments

string name - A texture name.

void setNodeLightUsage(int usage)

Sets the type of lighting for the render node.

Arguments

int usage - The lighting type. Can be one of the following:

int getNodeLightUsage()

Returns the type of lighting of the render node.

Return value

The lighting type. Can be one of the following:

int isPanorama180()

Returns a value indicating if a 180-degree panoramic rendering is enabled.

Return value

1 if a 180-degree panoramic rendering is enabled; otherwise, 0.

int isPanorama360()

Returns a value indicating if a 360-degree panoramic rendering is enabled.

Return value

1 if a 360-degree panoramic rendering is enabled; otherwise, 0.

void setRenderMode(int mode)

Sets the specified render mode. The mode determines the set buffers to be rendered.

Arguments

int mode

int getRenderMode()

Returns the current render mode. The mode determines the set buffers to be rendered.

Return value

void setSkipFlags(int flags)

Sets the skip flag for the current viewport.

Arguments

int flags - A skip flag.

int getSkipFlags()

Returns the skip flag set for the current viewport.

Return value

A skip flag.

int isStereo()

Returns a value indicating if the stereo rendering is enabled for the current viewport (one of the stereo modes is set).

Return value

1 if the stereo rendering is enabled; otherwise, 0.

void setStereoDistance(float distance)

Sets the focal distance for stereo rendering (distance in the world space to the point where two views line up, i.e. to the zero parallax plane).

Arguments

float distance - A focal distance in units.

float getStereoDistance()

Returns the focal distance for stereo rendering (distance in the world space to the point where two views line up, i.e. to the zero parallax plane).

Return value

A focal distance in units.

void setStereoOffset(float offset)

Updates the virtual camera offset (an offset after the perspective projection).

Arguments

float offset - A virtual camera offset in units.

float getStereoOffset()

Returns the virtual camera offset (an offset after the perspective projection).

Return value

A virtual camera offset in units.

void setStereoRadius(float radius)

Updates the radius for stereo (the half of the separation distance between the cameras (i.e. between eyes)).

Arguments

float radius - A stereo radius in units. If a negative value is provided, 0 will be used instead.

float getStereoRadius()

Returns the current radius for stereo (the half of the separation distance between the cameras (i.e. between eyes)).

Return value

Stereo radius in units.

void appendSkipFlags(int flags)

Appends specified skip flags to the list of currently used ones.

Arguments

int flags - Skip flags to append.

int checkSkipFlags(int flags)

Returns a value indicating if the specified skip flags are set for the current viewport.

Arguments

int flags - Skip flags to check.

Return value

1 if the skip flags are set; otherwise, 0.

void removeSkipFlags(int flags)

Removes specified skip flags from the list of currently used ones.

Arguments

int flags - Skip flags to remove.

void render(Camera camera)

Renders an image from the specified camera.

To render an image from the camera to the TextureRender interface, do the following:

Source code (C#)

camera = new Camera();

texturerender->enable();
	viewport->render(camera);
texturerender->disable();

Arguments

Camera camera - Camera an image from which should be rendered.

void render(Camera camera, int width, int height)

Renders an image of the specified size from the specified camera to the current rendering target.

Arguments

Camera camera - Camera, an image from which should be rendered.
int width - Image width, in pixels.
int height - Image height, in pixels.

void renderEngine(Camera camera)

Renders an Engine viewport for the specified camera to the current rendering target. This method renders a splash screen and provides an image in accordance with panoramic and stereo rendering settings.

Arguments

Camera camera - Camera, an image from which should be rendered.

void renderImage2D(Camera camera, Image image)

Renders an image from the camera to the given 2D image.

Notice

This method sets the format of the 2D image to one of the following values:

RGBA16F - in case if initial image format was 16-bit or 32-bit per channel float
RGBA8 - otherwise

Arguments

Camera camera - Camera, an image from which should be rendered.
Image image - Target 2D image to save the result to.

void renderImage2D(Camera camera, Image image, int width, int height, int hdr = 0)

Renders an image of the specified size from the camera to the 2D image.

Arguments

Camera camera - Camera, an image from which should be rendered.
Image image - Target 2D image to save the result to.
int width - Image width, in pixels.
int height - Image height, in pixels.
int hdr - HDR flag.
Notice
This parameter determines the format of the 2D image:
- 1 - image format will be set to RGBA16F
- 0 - image format will be set to RGBA8

void renderImageCube(Camera camera, Image image, int size, int hdr = 0, int local_space = 0)

Renders the image from the camera to the cube map of the specified size.

Arguments

Camera camera - Camera, an image from which should be rendered.
Image image - Target cube map to save the result to.
int size - Cube map edge size.
int hdr - HDR flag.
Notice
This parameter determines the format of the 2D image:
- 1 - image format will be set to RGBA16F
- 0 - image format will be set to RGBA8
int local_space - A flag indicating if the camera angle should be used for the cube map rendering.

void renderImageCube(Camera camera, Image image)

Renders the image from the camera into the cube map.

Arguments

Camera camera - Camera, an image from which should be rendered.
Image image - Target cube map to save the result to.

void renderNode(Camera camera, Node node)

Renders the given node with all children to the current rendering target.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node node - Node to be rendered.

void renderNode(Camera camera, Node node, int width, int height)

Renders the given node with all children to the current rendering target.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node node - Node to be rendered.
int width - Image width, in pixels.
int height - Image height, in pixels.

void renderNodeImage2D(Camera camera, Node node, Image image, int width, int height, int hdr)

Renders the given node with all children to the 2D image of the specified size.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node node - Node to be rendered.
Image image - Target 2D image to save the result to.
int width - Image width, in pixels.
int height - Image height, in pixels.
int hdr - HDR flag.
Notice
This parameter determines the format of the 2D image:
- 1 - image format will be set to RGBA16F
- 0 - image format will be set to RGBA8

void renderNodeImage2D(Camera camera, Node node, Image image)

Renders the given node with all children to the specified 2D image.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node node - Node to be rendered.
Image image - Target 2D image to save the result to.

void renderNodeTexture2D(Camera camera, Node node, Texture texture)

Renders the given node with all children to the specified 2D texture.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node node - Node to be rendered.
Texture texture - Target 2D texture to save the result to.

void renderNodes(Camera camera, Node[] nodes)

Renders given nodes with all their children to the current rendering target.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node[] nodes - List of the nodes to be rendered.

void renderNodes(Camera camera, Node[] nodes, int width, int height)

Renders given nodes with all their children to the current rendering target of the specified size.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node[] nodes - List of the nodes to be rendered.
int width - Image width, in pixels.
int height - Image height, in pixels.

void renderNodesImage2D(Camera camera, Node[] nodes, Image image)

Renders given nodes with all their children to the specified 2D image.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node[] nodes - List of the nodes to be rendered.
Image image - Target 2D image to save the result to.

void renderNodesImage2D(Camera camera, Node[] nodes, Image image, int width, int height, int hdr)

Renders given nodes with all their children to the 2D image of the specified size.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node[] nodes - List of the nodes to be rendered.
Image image - Target 2D image to save the result to.
int width - Image width, in pixels.
int height - Image height, in pixels.
int hdr - HDR flag.
Notice
This parameter determines the format of the 2D image:
- 1 - image format will be set to RGBA16F
- 0 - image format will be set to RGBA8

void renderNodesTexture2D(Camera camera, Node[] nodes, Texture texture)

Renders given nodes with all their children to the specified 2D texture.

Arguments

Camera camera - Camera, an image from which should be rendered.
Node[] nodes - List of the nodes to be rendered.
Texture texture - Target 2D texture to save the result to.

void renderStereo(Camera camera_left, Camera camera_right, string stereo_material)

Renders a stereo image in the current viewport.

Arguments

Camera camera_left - Camera that renders an image for the left eye.
Camera camera_right - Camera that renders an image for the right eye.
string stereo_material - List of names of stereo materials to be used.

void renderTexture2D(Camera camera, Texture texture)

Renders an image from the camera to the specified 2D texture.

Arguments

Camera camera - Camera, an image from which should be rendered.
Texture texture - Target 2D texture to save the result to.

int MODE_DEFAULT

Description

Enables the default stereo mode - no stereo and panoramic rendering in the current viewport is available. This mode is set by default for a new viewport.

int MODE_PANORAMA_180_CURVED

Description

Enables rendering of the viewport as a 180-degree panorama with curved edges.

int MODE_PANORAMA_180_FISHEYE

Description

Enables rendering of the viewport as a 180-degree spherical panorama (fisheye).

int MODE_PANORAMA_180_LINEAR

Description

Enables rendering of the viewport as a 180-degree linear panorama without distortion at the edges.

int MODE_PANORAMA_360_CURVED

Description

Enables rendering of the viewport as a 360-degree panorama with curved edges.

int MODE_PANORAMA_360_FISHEYE

Description

Enables rendering of the viewport as a 360-degree spherical panorama (fisheye).

int MODE_PANORAMA_360_LINEAR

Description

Enables rendering of the viewport as a 360-degree linear panorama without distortion at the edges.

int MODE_STEREO_ANAGLYPH

Description

Enables the anaglyph stereo mode that is viewed with red-cyan anaglyph glasses.

int MODE_STEREO_HORIZONTAL

Description

Enables the horizontal stereo mode that is supported on mobile devices.

int MODE_STEREO_INTERLACED

Description

Enables the interlaced stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.

int MODE_STEREO_REPLICATE

Description

Enables the separate images stereo mode. This mode serves to output two separate images for each of the eye. It can be used with any VR/AR output devices that support separate images output, e.g. for 3D video glasses or helmets (HMD).

int MODE_STEREO_SEPARATE

Description

Enables the replicate images stereo mode.

int MODE_STEREO_VERTICAL

Description

Enables the vertical stereo mode that is supported on mobile devices.

int SKIP_DYNAMIC_REFLECTIONS

Description

Skip rendering of dynamic reflections in the viewport.

int SKIP_FORMAT_RG11B10

Description

Skip rendering of RG11B10 formats in the viewport.

int SKIP_POSTEFFECTS

Description

Skip rendering of post effects in the viewport.

int SKIP_SHADOWS

Description

Skip shadows rendering in the viewport.

int SKIP_SRGB

Description

Skip rendering of the srgb color space.

int

Description

Disables data streaming in the process of rendering.

int

Description

Skip rendering of transparent objects in the viewport.

int SKIP_VELOCITY_BUFFER

Description

Skip rendering to the velocity buffer for the viewport.

int SKIP_VISUALIZER

Description

Skip rendering of the visualizer in the viewport. This flag is set by default for a new viewport.

int USAGE_AUX_LIGHT

Description

Use lighting from the auxiliary virtual scene containing one LightWorld (with 45, 45 and 45 degrees slope angles), scattering is not used.

int USAGE_NODE_LIGHT

Description

Use the node lighting.

int USAGE_WORLD_LIGHT

Description

Use lighting from the LightWorld set in the current loaded world.

int

Description

Render only depth.

int

Description

Render only depth and Gbuffer.

int

Description

Render depth, Gbuffer and final image.

Last update: 2018-06-04

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.Viewport Class

List of functions:

List of Variables:

Viewport Class

Members

static Viewport()

void setAspectCorrection(int correction)

Arguments

int getAspectCorrection()

Return value

int addCallback(int callback, Unigine::CallbackBase * func)

Arguments

Return value

void clearCallbacks(int callback)

Arguments

void removeCallback(int callback, int num)

Arguments

void setFirstFrame(int frame)

Arguments

int getFirstFrame()

Return value

int getID()

Return value

void setMode(int mode)

Arguments

int getMode()

Return value

void setNodeEnvironmentTextureName(string name)

Arguments

void setNodeLightUsage(int usage)

Arguments

int getNodeLightUsage()

Return value

int isPanorama180()

Return value

int isPanorama360()

Return value

void setRenderMode(int mode)

Arguments

int getRenderMode()

Return value

void setSkipFlags(int flags)

Arguments

int getSkipFlags()

Return value

int isStereo()

Return value

void setStereoDistance(float distance)

Arguments

float getStereoDistance()

Return value

void setStereoOffset(float offset)

Arguments

float getStereoOffset()

Return value

void setStereoRadius(float radius)

Arguments

float getStereoRadius()

Return value

void appendSkipFlags(int flags)

Arguments

int checkSkipFlags(int flags)

Arguments

Return value

void removeSkipFlags(int flags)

Arguments

void render(Camera camera)

Arguments

void render(Camera camera, int width, int height)

Arguments

void renderEngine(Camera camera)

Arguments

void renderImage2D(Camera camera, Image image)

Arguments

void renderImage2D(Camera camera, Image image, int width, int height, int hdr = 0)

Arguments

void renderImageCube(Camera camera, Image image, int size, int hdr = 0, int local_space = 0)

Arguments

void renderImageCube(Camera camera, Image image)

Arguments