Unigine::Viewport Class

Header:

#include <UnigineViewport.h>

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

The main use cases of the Viewport class are as follows:

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
ViewportPtr viewport = Viewport::create();

TextureRenderPtr texturerender = TextureRender::create();
texturerender->create2D(512, 512, Texture::USAGE_RENDER);
TexturePtr texture = Texture::create();
texture->create2D(512,512,Texture::FORMAT_RGBA8,Texture::USAGE_RENDER); // create 512 x 512 render target

CameraPtr camera = Camera::create();
// 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
ViewportPtr viewport = Viewport::create();

TextureRenderPtr texturerender = TextureRender::create();
texturerender->create2D(512, 512, Texture::USAGE_RENDER);
TexturePtr left_texture = Texture::create();
TexturePtr right_texture = Texture::create();

// 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);

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

// rendering
texturerender->enable();
	texturerender->setColorTexture(0,left_texture);
	texturerender->setColorTexture(1,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
ViewportPtr viewport = Viewport::create();

TexturePtr texture = Texture::create();
texture->create2D(512,512,Texture::FORMAT_RGBA8,Texture::USAGE_RENDER); // create 512 x 512 render target

CameraPtr camera = Camera::create();
// 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:

You can set callbacks before and after any rendering pass using the addCallback() method: thus, getting access to the intermediate state of rendering buffers and matrices. Some of them are read-only, but most of them can be modified ad hoc. The callback can get a Renderer pointer.

Thanks to this feature you can get direct access to G-Buffer, SSAO, lights or any other effect. One more example: you can create a custom post-process and apply it before TAA, thus, getting correct antialiased image as a result. You can even create your own custom light sources, decals, etc. The feature can also be useful for custom sensors view.

Viewport class has different rendering modes: RENDER_DEPTH (depth only), RENDER_DEPTH_GBUFFER (depth + G-buffer), RENDER_DEPTH_GBUFFER_FINAL (depth + G-buffer + final image). This can give you extra performance boost if you need only depth info, for example.

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. See the usage example below.

Methods:

Name	Description View: Sort by:
*create*	Creates a new viewport with default settings.
setAspectCorrection	Sets the aspect correction for current viewport.
getAspectCorrection	Return the value indicating if the aspect correction enabled for current viewport.
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.
setFirstFrame	Sets a value indicating if the first frame should be enabled over the current frame.
getFirstFrame	Returns a value indicating if the first frame is enabled over the current frame.
getID	Returns the viewport ID.
setMode	Sets the rendering mode for the current viewport.
getMode	Returns the rendering mode set for the current viewport.
setNodeEnvironmentTextureName	Sets a name for the environment texture.
setNodeLightUsage	Sets the type of lighting for the render node.
getNodeLightUsage	Returns the type of lighting of the render node.
isPanorama180	Returns a value indicating if a 180-degree panoramic rendering is enabled.
isPanorama360	Returns a value indicating if a 360-degree panoramic rendering is enabled.
setRenderMode	Sets the specified render mode.
getRenderMode	Returns the current render mode.
setSkipFlags	Sets the skip flag for the current viewport.
getSkipFlags	Returns the skip flag set for the current viewport.
isStereo	Returns a value indicating if the stereo rendering is enabled for the current viewport (one of the stereo modes is set).
setStereoDistance	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).
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).
setStereoOffset	Updates the virtual camera offset (an offset after the perspective projection).
getStereoOffset	Returns the virtual camera offset (an offset after the perspective projection).
setStereoRadius	Updates the radius for stereo (the half of the separation distance between the cameras (i.e. between eyes)).
getStereoRadius	Returns the current radius for stereo (the half of the separation distance between the cameras (i.e. between eyes)).
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	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	Enables rendering of the viewport as a 180-degree panorama with curved edges.
MODE_PANORAMA_180_FISHEYE	Enables rendering of the viewport as a 180-degree spherical panorama (fisheye).
MODE_PANORAMA_180_LINEAR	Enables rendering of the viewport as a 180-degree linear panorama without distortion at the edges.
MODE_PANORAMA_360_CURVED	Enables rendering of the viewport as a 360-degree panorama with curved edges.
MODE_PANORAMA_360_FISHEYE	Enables rendering of the viewport as a 360-degree spherical panorama (fisheye).
MODE_PANORAMA_360_LINEAR	Enables rendering of the viewport as a 360-degree linear panorama without distortion at the edges.
MODE_STEREO_ANAGLYPH	Enables the anaglyph stereo mode that is viewed with red-cyan anaglyph glasses.
MODE_STEREO_HORIZONTAL	Enables the horizontal stereo mode that is supported on mobile devices.
MODE_STEREO_INTERLACED	Enables the interlaced stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
MODE_STEREO_REPLICATE	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	Enables the replicate images stereo mode.
MODE_STEREO_VERTICAL	Enables the vertical stereo mode that is supported on mobile devices.
SKIP_DYNAMIC_REFLECTIONS	Skip rendering of dynamic reflections in the viewport.
SKIP_FORMAT_RG11B10	Skip rendering of RG11B10 formats in the viewport.
SKIP_POSTEFFECTS	Skip rendering of post effects in the viewport.
SKIP_SHADOWS	Skip shadows rendering in the viewport.
SKIP_SRGB	Skip rendering of the srgb color space.
SKIP_STREAMING	Disables data streaming in the process of rendering.
SKIP_TRANSPARENT	Skip rendering of transparent objects in the viewport.
SKIP_VELOCITY_BUFFER	Skip rendering to the velocity buffer for the viewport.
SKIP_VISUALIZER	Skip rendering of the visualizer in the viewport. This flag is set by default for a new viewport.
USAGE_AUX_LIGHT	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	Use the node lighting.
USAGE_WORLD_LIGHT	Use lighting from the LightWorld set in the current loaded world.
RENDER_DEPTH	Render only depth.
RENDER_DEPTH_GBUFFER	Render only depth and Gbuffer.
RENDER_DEPTH_GBUFFER_FINAL	Render depth, Gbuffer and final image.
RENDER_REPROJECTION	Render stereo reprojection for VR.

Viewport Class

Members

static ViewportPtr create ( )

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.

void * addCallback( int callback, Unigine::CallbackBase1< Unigine::Renderer * > * 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::CallbackBase1< Unigine::Renderer * > * func - Callback pointer.

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

bool removeCallback( int callback, void * 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

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.
void * id - Callback ID obtained when adding it.

Return value

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

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.

Arguments

const char * 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:

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( const Ptr<Camera> & camera )

Renders an image from the specified camera. This method is used to integrate the engine to a 3rd party renderer.

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

Source code (C++)

camera = Camera::create();

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

Arguments

const Ptr<Camera> & camera - Camera an image from which should be rendered.

void render( const Ptr<Camera> & camera, int width, int height )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
int width - Image width, in pixels.
int height - Image height, in pixels.

void renderEngine( const Ptr<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

const Ptr<Camera> & camera - Camera, an image from which should be rendered.

void renderImage2D( const Ptr<Camera> & camera, const Ptr<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

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

void renderImage2D( const Ptr<Camera> & camera, const Ptr<Image> & image, int width, int height, int hdr = 0 )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<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( const Ptr<Camera> & camera, const Ptr<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

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<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( const Ptr<Camera> & camera, const Ptr<Image> & image )

Renders the image from the camera into the cube map.

Arguments

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

void renderNode( const Ptr<Camera> & camera, const Ptr<Node> & node )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<Node> & node - Node to be rendered.

void renderNode( const Ptr<Camera> & camera, const Ptr<Node> & node, int width, int height )

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

Arguments

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

void renderNodeImage2D( const Ptr<Camera> & camera, const Ptr<Node> & node, const Ptr<Image> & image, int width, int height, int hdr )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<Node> & node - Pointer to the node to be rendered.
const Ptr<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( const Ptr<Camera> & camera, const Ptr<Node> & node, const Ptr<Image> & image )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<Node> & node - Pointer to the node to be rendered.
const Ptr<Image> & image - Target 2D image to save the result to.

void renderNodeTexture2D( const Ptr<Camera> & camera, const Ptr<Node> & node, const Ptr<Texture> & texture )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Ptr<Node> & node - Pointer to the node to be rendered.
const Ptr<Texture> & texture - Target 2D texture to save the result to.

void renderNodes( const Ptr<Camera> & camera, const Vector< Ptr<Node> > & nodes )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Vector< Ptr<Node> > & nodes - List of the nodes to be rendered.

void renderNodes( const Ptr<Camera> & camera, const Vector< Ptr<Node> > & nodes, int width, int height )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Vector< Ptr<Node> > & nodes - List of the nodes to be rendered.
int width - Image width, in pixels.
int height - Image height, in pixels.

void renderNodesImage2D( const Ptr<Camera> & camera, const Vector< Ptr<Node> > & nodes, const Ptr<Image> & image )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Vector< Ptr<Node> > & nodes - List of the nodes to be rendered.
const Ptr<Image> & image - Target 2D image to save the result to.

void renderNodesImage2D( const Ptr<Camera> & camera, const Vector< Ptr<Node> > & nodes, const Ptr<Image> & image, int width, int height, int hdr )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Vector< Ptr<Node> > & nodes - List of the nodes to be rendered.
const Ptr<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( const Ptr<Camera> & camera, const Vector< Ptr<Node> > & nodes, const Ptr<Texture> & texture )

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

Arguments

const Ptr<Camera> & camera - Camera, an image from which should be rendered.
const Vector< Ptr<Node> > & nodes - List of the nodes to be rendered.
const Ptr<Texture> & texture - Target 2D texture to save the result to.

void renderStereo( const Ptr<Camera> & camera_left, const Ptr<Camera> & camera_right, const char * stereo_material )

Renders a stereo image in the current viewport.

Arguments

const Ptr<Camera> & camera_left - Camera that renders an image for the left eye.
const Ptr<Camera> & camera_right - Camera that renders an image for the right eye.
const char * stereo_material - List of names of stereo materials to be used.

void renderTexture2D( const Ptr<Camera> & camera, const Ptr<Texture> & texture )

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

Arguments

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

void setStereoHiddenAreaMesh( const Ptr<Mesh> & hidden_area_mesh_left, const Ptr<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

const Ptr<Mesh> & hidden_area_mesh_left - Mesh representing hidden area for the left eye.
const Ptr<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-01-14

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

See also#

Methods:

Variables:

Viewport Class

Members

static ViewportPtr create ( )

void setAspectCorrection( int correction )

Arguments

int getAspectCorrection( )

Return value

void * addCallback( int callback, Unigine::CallbackBase1< Unigine::Renderer * > * func )

Arguments

Return value

void clearCallbacks( int callback )

Arguments

bool removeCallback( int callback, void * id )

Arguments

Return value

void setFirstFrame( int frame )

Arguments

int getFirstFrame( )

Return value

int getID( )

Return value

void setMode( int mode )

Arguments

int getMode( )

Return value

void setNodeEnvironmentTextureName( const char * 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( const Ptr<Camera> & camera )

Arguments

void render( const Ptr<Camera> & camera, int width, int height )

Arguments

void renderEngine( const Ptr<Camera> & camera )

Arguments

void renderImage2D( const Ptr<Camera> & camera, const Ptr<Image> & image )

Arguments

void renderImage2D( const Ptr<Camera> & camera, const Ptr<Image> & image, int width, int height, int hdr = 0 )

Arguments

void renderImageCube( const Ptr<Camera> & camera, const Ptr<Image> & image, int size, int hdr = 0, int local_space = 0 )

Arguments