This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.RenderContext Class

This class is used to manage render context.

RenderContext Class

Members


int CreateContext ( IntPtr handle, int width, int height ) #

Creates a new rendering context.

Arguments

  • IntPtr handle - Window handle.
  • int width - Canvas width.
  • int height - Canvas height.

Return value

1 if rendering context is created successfully; otherwise, 0.

bool IsCreated ( ) #

Returns a value indicating if rendering context is created.

Return value

1 if rendering context is created successfully; otherwise, 0.

int DestroyContext ( ) #

Destroys the rendering context.

Return value

1 if the rendering context is destroyed successfully; otherwise, 0.

int GetContextAPI ( ) #

Returns the graphics API of the rendering context.

Return value

One of the following values:

string GetContextName ( ) #

Returns the name of the graphics API of the rendering context.

Return value

One of the following values:
  • opengl
  • direct3d11

IntPtr GetD3D11Context ( ) #

Returns a pointer to the existing ID3D11DeviceContext interface.

Return value

ID3D11DeviceContext interface pointer.

IntPtr GetD3D11DepthStencil ( ) #

Returns a pointer to the depth stencil texture.

Return value

Depth stencil texture pointer.

IntPtr GetD3D11DepthStencilView ( ) #

Returns a pointer to the existing ID3D11DepthStencilView interface.

Return value

ID3D11DepthStencilView interface pointer.

IntPtr GetD3D11Device ( ) #

Returns a pointer to the existing ID3D11Device interface.

Return value

ID3D11Device interface pointer.

IntPtr GetD3D11RenderTarget ( ) #

Returns a pointer to the render target texture.

Return value

Render target texture pointer.

IntPtr GetD3D11RenderTargetView ( ) #

Returns a pointer to the existing ID3D11RenderTargetView interface.

Return value

ID3D11RenderTargetView interface pointer.

IntPtr GetD3D11SwapChain ( ) #

Returns a pointer to the existing IDXGISwapChain interface.

Return value

IDXGISwapChain interface pointer.

IntPtr GetHandle ( ) #

Returns a window handle.

Return value

Window handle.

IntPtr GetGLContext ( ) #

Returns a pointer to the OpenGL context.

Return value

OpenGL context pointer.

int ResizeWindow ( int width, int height ) #

Resizes the window.

Arguments

  • int width - New window width.
  • int height - New window height.

Return value

1 if the window is resized successfully; otherwise, 0.

int RenderWindow ( ) #

Renders the window.

Return value

1 if the window is rendered successfully; otherwise, 0.

int SwapWindow ( ) #

Swaps the window.

Return value

1 if the window is swapped successfully; otherwise, 0.

bool IsReady ( ) #

Returns a value indicating if the rendering context is ready.

Return value

1 if the rendering context is ready; otherwise, 0.

IntPtr CreateVisual ( ) #

Creates a visual context.

Return value

Pointer to the created visual context.
Last update: 2020-04-10
Build: ()