Unigine.Viewport Class

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, RenderTarget interface (a frame buffers abstraction), etc.

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

Source code (C#)

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

RenderTarget rendertarget = new RenderTarget();
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
rendertarget.BindColorTexture(0,texture);
rendertarget.Enable();
	viewport.Render(camera);
rendertarget.Disable();
rendertarget.UnbindAll();

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

Source code (C#)

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

RenderTarget rendertarget = new RenderTarget();
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
rendertarget.BindColorTexture(0,left_texture);
rendertarget.BindColorTexture(1,right_texture);
rendertarget.Enable();
	viewport.RenderStereo(left_eye,right_eye,"post_stereo_separate"); // use "post_stereo_separate" material in order to render to both textures
rendertarget.Disable();
rendertarget.UnbindAll();

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 transferred 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

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

// rendering

// saving current render state and clearing it 
RenderState.SaveState();
RenderState.ClearStates();
		
// rendering an image from the camera to the texture
viewport.RenderTexture2D(camera, texture);

// restoring back render state
RenderState.RestoreState();

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

Render a node to the image (data will be transferred 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.

Properties:

Name	Description
int NodeLightUsage	The type of lighting of the render node.
float StereoOffset	The virtual camera offset (an offset after the perspective projection).
float StereoRadius	The current radius for stereo (the half of the separation distance between the cameras (i.
float StereoDistance	The focal distance for stereo rendering (distance in the world space to the point where two views line up, i.
bool IsPanorama360	A value indicating if a 360-degree panoramic rendering is enabled.
bool IsPanorama180	A value indicating if a 180-degree panoramic rendering is enabled.
bool IsStereo	A value indicating if the stereo rendering is enabled for the current viewport (one of the stereo modes is set).
int RenderMode	The current render mode.
int Mode	The rendering mode set for the current viewport.
int SkipFlags	The skip flag set for the current viewport.
int FirstFrame	A value indicating if the first frame is enabled over the current frame.
int AspectCorrection	Return the value indicating if the aspect correction enabled for current viewport.

Methods:

Name	Description View: Sort by:
Viewport	Creates a new viewport with default settings.
addCallback	Adds a callback for the specified stage of the rendering sequence.
clearCallbacks	Clears all added callbacks for the specified stage of the rendering sequence.
removeCallback	Removes the specified callback from the list of callbacks for the specified stage of the rendering sequence.
GetID	Returns the viewport ID.
SetNodeEnvironmentTextureName	Sets a name for the environment texture.
AppendSkipFlags	Appends specified skip flags to the list of currently used ones.
CheckSkipFlags	Returns a value indicating if the specified skip flags are set for the current viewport.
RemoveSkipFlags	Removes specified skip flags from the list of currently used ones.
Render	Renders an image from the specified camera.
RenderEngine	Renders an Engine viewport for the specified camera to the current rendering target.
RenderImage2D	Renders an image from the camera to the given 2D image.
RenderImageCube	Renders the image from the camera to the cube map of the specified size.
RenderNode	Renders the given node with all children to the current rendering target.
RenderNodeImage2D	Renders the given node with all children to the 2D image of the specified size.
RenderNodeTexture2D	Renders the given node with all children to the specified 2D texture.
RenderNodes	Renders given nodes with all their children to the current rendering target.
RenderNodesImage2D	Renders given nodes with all their children to the specified 2D image.
RenderNodesTexture2D	Renders given nodes with all their children to the specified 2D texture.
RenderStereo	Renders a stereo image in the current viewport.
RenderTexture2D	Renders an image from the camera to the specified 2D texture.
SetStereoHiddenAreaMesh	Sets custom meshes to be used for culling pixels, that are not visible in VR.
ClearStereoHiddenAreaMesh	Clears meshes that represent hidden areas for both, left and right eye.

Variables:

Name	Description
MODE_DEFAULT = 0	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.
MODE_PANORAMA_180_CURVED = 7	Enables rendering of the viewport as a 180-degree panorama with curved edges.
MODE_PANORAMA_180_FISHEYE = 9	Enables rendering of the viewport as a 180-degree spherical panorama (fisheye).
MODE_PANORAMA_180_LINEAR = 8	Enables rendering of the viewport as a 180-degree linear panorama without distortion at the edges.
MODE_PANORAMA_360_CURVED = 10	Enables rendering of the viewport as a 360-degree panorama with curved edges.
MODE_PANORAMA_360_FISHEYE = 12	Enables rendering of the viewport as a 360-degree spherical panorama (fisheye).
MODE_PANORAMA_360_LINEAR = 11	Enables rendering of the viewport as a 360-degree linear panorama without distortion at the edges.
MODE_STEREO_ANAGLYPH = 1	Enables the anaglyph stereo mode that is viewed with red-cyan anaglyph glasses.
MODE_STEREO_HORIZONTAL = 3	Enables the horizontal stereo mode that is supported on mobile devices.
MODE_STEREO_INTERLACED = 2	Enables the interlaced stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
MODE_STEREO_REPLICATE = 6	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).
MODE_STEREO_SEPARATE = 5	Enables the replicate images stereo mode.
MODE_STEREO_VERTICAL = 4	Enables the vertical stereo mode that is supported on mobile devices.
SKIP_DYNAMIC_REFLECTIONS = 1 << 3	Skip rendering of dynamic reflections in the viewport.
SKIP_FORMAT_RG11B10 = 1 << 6	Skip rendering of RG11B10 formats in the viewport.
SKIP_POSTEFFECTS = 1 << 2	Skip rendering of post effects in the viewport.
SKIP_SHADOWS = 1 << 0	Skip shadows rendering in the viewport.
SKIP_SRGB = 1 << 5	Skip rendering of the srgb color space.
SKIP_STREAMING = 1 << 8	Disables data streaming in the process of rendering.
SKIP_TRANSPARENT = 1 << 7	Skip rendering of transparent objects in the viewport.
SKIP_VELOCITY_BUFFER = 1 << 4	Skip rendering to the velocity buffer for the viewport.
SKIP_VISUALIZER = 1 << 1	Skip rendering of the visualizer in the viewport. This flag is set by default for a new viewport.
USAGE_AUX_LIGHT = 1	Use lighting from the auxiliary virtual scene containing one LightWorld (with 45, 45 and 45 degrees slope angles), scattering is not used.
USAGE_NODE_LIGHT = 2	Use the node lighting.
USAGE_WORLD_LIGHT = 0	Use lighting from the LightWorld set in the current loaded world.
RENDER_DEPTH = 0	Render only depth.
RENDER_DEPTH_GBUFFER = 1	Render only depth and Gbuffer.
RENDER_DEPTH_GBUFFER_FINAL = 2	Render depth, Gbuffer and final image.
RENDER_REPROJECTION = 3	Render stereo reprojection for VR.

Viewport Class

Properties

int NodeLightUsage#

The type of lighting of the render node.

set

Sets the type of lighting for the render node.

set value - The lighting type. Can be one of the following:

float StereoOffset#

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

set

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

set value - A virtual camera offset in units.

float StereoRadius#

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

set

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

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

float StereoDistance#

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).

set

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).

set value - A focal distance in units.

bool IsPanorama360#

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

bool IsPanorama180#

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

bool IsStereo#

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

int RenderMode#

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

set

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

set value -

int Mode#

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

set

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

set value - A rendering mode.

int SkipFlags#

The skip flag set for the current viewport.

set

Sets the skip flag for the current viewport.

set value - A skip flag.

int FirstFrame#

A value indicating if the first frame is enabled over the current frame.

set

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

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

int AspectCorrection#

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

set

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

set value - 1 to enable aspect correction, 0 to disable.

Members

static Viewport ( ) #

Creates a new viewport with default settings.

IntPtr addCallback ( Render.CALLBACK_INDEX callback, CallbackDelegate 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

Render.CALLBACK_INDEX 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.
CallbackDelegate func - Callback function with the following signature: void CallbackDelegate(Renderer renderer)

Return value

ID of the last added callback of the specified type, if the callback was added successfully; otherwise, nullptr. This ID can be used to remove this callback when necessary.

void clearCallbacks ( Render.CALLBACK_INDEX 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

Render.CALLBACK_INDEX 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.

bool removeCallback ( Render.CALLBACK_INDEX callback, IntPtr id ) #

Removes the specified callback 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

Render.CALLBACK_INDEX 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.
IntPtr id - Callback ID obtained when adding it.

Return value

True if the callback with the given ID was removed successfully; otherwise false.

int GetID ( ) #

Returns the viewport ID.

Return value

Viewport ID.

void SetNodeEnvironmentTextureName ( string name ) #

Sets a name for the environment texture.

Arguments

string name - A texture name.

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 RenderTarget interface, do the following:

Source code (C#)

camera = new Camera();

rendertarget->enable();
	viewport->render(camera);
rendertarget->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.

void SetStereoHiddenAreaMesh ( Mesh hidden_area_mesh_left, Mesh hidden_area_mesh_right ) #

Sets custom meshes to be used for culling pixels, that are not visible in VR.

Notice

Requires render_stereo_hidden_area = 2

Arguments

Mesh hidden_area_mesh_left - Mesh representing hidden area for the left eye.
Mesh hidden_area_mesh_right - Mesh representing hidden area for the right eye.

void ClearStereoHiddenAreaMesh ( ) #

Clears meshes that represent hidden areas for both, left and right eye. Hidden areas are used for culling pixels, that are not visible in VR

Last update: 2020-06-01

Help improve this article

Was this article helpful?

Report a problem related to this article

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