ViewportRenderInstance

Summary

Remarks

Danger

All calls made within this class MUST be performed on the Master Thread. See Threads.RunLater on how to safely call this from an asynchronous thread. Failure to comply with this can cause catastrophical failures as the engine is not designed for this.

Definition

Namespace: SDT4.Managed.Renderer.XRP
Assembly: SDT4.Managed.Renderer.dll

sealed class ViewportRenderInstance

Inheritance:

Object ➔ ViewportRenderInstance

Implements:

IDisposable, IRenderCanvasAttacher

Fields

Name	Type	Description

Properties

Name	Type	Description
`public get; set; RenderCanvas`	RenderCanvas	The render canvas attached to this viewport. This will throw an InvalidOperationException if ViewportRenderInstance.OwnsCanvas is false.
`public get; OwnsCanvas`	Boolean	Denotes if the render canvas is owned by the viewport or not. If this is NOT owned by this viewport, the ViewportRenderInstance.RenderCanvas is invalid

Methods

public Void SetCameraActor(Actor actor)

Summary: Attaches the camera of an actor to this render instance

Remarks: If actor is not owned by the scene render instance that provided

Parameters:

actor (Actor):

public Void SetRenderArea(Vector2i extent, Vector2i offset)

Summary: Sets the render extent of the viewport on the canvas.

Remarks: Invalid regions get clamped.

Parameters:

extent (Vector2i):
offset (Vector2i):

public Void Dispose()

public virtual String ToString()

Returns:

String: