Viewport (Nu)

Viewport Type

Namespace: Nu
Assembly: Nu.dll
Base Type: obj
All Interfaces: IEquatable<Viewport> , IStructuralEquatable

Describes the bounds of a viewport. TODO: add missing doc comments to this type's functions.

Record fields

Record Field	Description
`Bounds` Full Usage: `Bounds` Field type: `Box2i`	Field type: `Box2i`
`DisplayScalar` Full Usage: `DisplayScalar` Field type: `int`	Field type: `int`
`DistanceFar` Full Usage: `DistanceFar` Field type: `single`	Field type: `single`
`DistanceNear` Full Usage: `DistanceNear` Field type: `single`	Field type: `single`
`SsaoResolutionDivisor` Full Usage: `SsaoResolutionDivisor` Field type: `int`	Field type: `int`

Instance members

Instance member	Description
`this.AspectRatio` Full Usage: `this.AspectRatio` Returns: `single`	The aspect ratio of this viewport. Returns: `single`
`this.Projection2d` Full Usage: `this.Projection2d` Returns: `Matrix4x4`	Compute the 2d projection matrix. Returns: `Matrix4x4`
`this.ShadowMapResolution` Full Usage: `this.ShadowMapResolution` Returns: `Vector2i`	The shadow map buffer resolution appropriate for this viewport. Returns: `Vector2i`
`this.ShadowTextureResolution` Full Usage: `this.ShadowTextureResolution` Returns: `Vector2i`	The shadow texture buffer resolution appropriate for this viewport. Returns: `Vector2i`
`this.SsaoResolution` Full Usage: `this.SsaoResolution` Returns: `Vector2i`	The screen-space ambient occlusion texture buffer resolution appropriate for this viewport. Returns: `Vector2i`

Static members

Static member	Description
`Viewport.getFrustum eyeCenter eyeRotation eyeFieldOfView viewport` Full Usage: `Viewport.getFrustum eyeCenter eyeRotation eyeFieldOfView viewport` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` viewport : `Viewport` Returns: `Frustum`	Compute a 3d view frustum. eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` viewport : `Viewport` Returns: `Frustum`
`Viewport.getProjection3d fieldOfView viewport` Full Usage: `Viewport.getProjection3d fieldOfView viewport` Parameters: fieldOfView : `single` viewport : `Viewport` Returns: `Matrix4x4`	Compute the 3d projection matrix. fieldOfView : `single` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.getView2d absolute eyeCenter eyeSize viewport` Full Usage: `Viewport.getView2d absolute eyeCenter eyeSize viewport` Parameters: absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`	Compute a 2d view matrix. absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.getView2dAbsolute arg1 eyeSize viewport` Full Usage: `Viewport.getView2dAbsolute arg1 eyeSize viewport` Parameters: arg0 : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`	Compute the 2d absolute view matrix. arg0 : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.getView2dRelative eyeCenter eyeSize viewport` Full Usage: `Viewport.getView2dRelative eyeCenter eyeSize viewport` Parameters: eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`	Compute the 2d relative view matrix. eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.getView3d eyeCenter eyeRotation` Full Usage: `Viewport.getView3d eyeCenter eyeRotation` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` Returns: `Matrix4x4`	Compute the 3d view matrix. eyeCenter : `Vector3` eyeRotation : `Quaternion` Returns: `Matrix4x4`
`Viewport.getViewProjection2d absolute eyeCenter eyeSize viewport` Full Usage: `Viewport.getViewProjection2d absolute eyeCenter eyeSize viewport` Parameters: absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`	Compute the 2d view projection matrix. absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.getViewProjection3d eyeCenter eyeRotation eyeFieldOfView viewport` Full Usage: `Viewport.getViewProjection3d eyeCenter eyeRotation eyeFieldOfView viewport` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` viewport : `Viewport` Returns: `Matrix4x4`	Compute a 3d view projection matrix. eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` viewport : `Viewport` Returns: `Matrix4x4`
`Viewport.make distanceNear distanceFar bounds` Full Usage: `Viewport.make distanceNear distanceFar bounds` Parameters: distanceNear : `single` distanceFar : `single` bounds : `Box2i` Returns: `Viewport`	distanceNear : `single` distanceFar : `single` bounds : `Box2i` Returns: `Viewport`
`Viewport.makeExterior ()` Full Usage: `Viewport.makeExterior ()` Returns: `Viewport`	Returns: `Viewport`
`Viewport.makeGeometry resolution` Full Usage: `Viewport.makeGeometry resolution` Parameters: resolution : `Vector2i` Returns: `Viewport`	resolution : `Vector2i` Returns: `Viewport`
`Viewport.makeImposter ()` Full Usage: `Viewport.makeImposter ()` Returns: `Viewport`	Returns: `Viewport`
`Viewport.makeInterior ()` Full Usage: `Viewport.makeInterior ()` Returns: `Viewport`	Returns: `Viewport`
`Viewport.makeOuter windowSize` Full Usage: `Viewport.makeOuter windowSize` Parameters: windowSize : `Vector2i` Returns: `Viewport`	windowSize : `Vector2i` Returns: `Viewport`
`Viewport.makeRaster bounds` Full Usage: `Viewport.makeRaster bounds` Parameters: bounds : `Box2i` Returns: `Viewport`	bounds : `Box2i` Returns: `Viewport`
`Viewport.mouseTo2dScreen arg1 eyeSize mousePosition viewport` Full Usage: `Viewport.mouseTo2dScreen arg1 eyeSize mousePosition viewport` Parameters: arg0 : `Vector2` eyeSize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`	Transform the given mouse position to 2d screen space. arg0 : `Vector2` eyeSize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`
`Viewport.mouseToEntity2d absolute entityPosition entitySize mousePosition viewport` Full Usage: `Viewport.mouseToEntity2d absolute entityPosition entitySize mousePosition viewport` Parameters: absolute : `bool` entityPosition : `Vector2` entitySize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`	Transform the given mouse position to 2d entity space (eye 2d coordinates). absolute : `bool` entityPosition : `Vector2` entitySize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`
`Viewport.mouseToScreen3d mousePosition viewport` Full Usage: `Viewport.mouseToScreen3d mousePosition viewport` Parameters: mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`	Transform the given mouse position to screen (normalized device coordinates). mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`
`Viewport.mouseToWorld2d absolute eyeCenter eyeSize mousePosition viewport` Full Usage: `Viewport.mouseToWorld2d absolute eyeCenter eyeSize mousePosition viewport` Parameters: absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`	Transform the given mouse position to 2d world space. absolute : `bool` eyeCenter : `Vector2` eyeSize : `Vector2` mousePosition : `Vector2` viewport : `Viewport` Returns: `Vector2`
`Viewport.mouseToWorld3d eyeCenter eyeRotation eyeFieldOfView mousePosition viewport` Full Usage: `Viewport.mouseToWorld3d eyeCenter eyeRotation eyeFieldOfView mousePosition viewport` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` mousePosition : `Vector2` viewport : `Viewport` Returns: `Ray3`	Transform the given mouse position to 3d world space. eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` mousePosition : `Vector2` viewport : `Viewport` Returns: `Ray3`
`Viewport.position2dToRay3d eyeCenter eyeRotation eyeFieldOfView position viewport` Full Usage: `Viewport.position2dToRay3d eyeCenter eyeRotation eyeFieldOfView position viewport` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` position : `Vector3` viewport : `Viewport` Returns: `Ray3`	Compute the relative 3d ray from the given absolute 2d position. TODO: also implement Position2dToPosition3d. eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` position : `Vector3` viewport : `Viewport` Returns: `Ray3`
`Viewport.position3dToPosition2d eyeCenter eyeRotation eyeFieldOfView position viewport` Full Usage: `Viewport.position3dToPosition2d eyeCenter eyeRotation eyeFieldOfView position viewport` Parameters: eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` position : `Vector3` viewport : `Viewport` Returns: `Vector3`	Compute the absolute 2d position from the given relative 3d position. eyeCenter : `Vector3` eyeRotation : `Quaternion` eyeFieldOfView : `single` position : `Vector3` viewport : `Viewport` Returns: `Vector3`
`Viewport.project source frame viewport` Full Usage: `Viewport.project source frame viewport` Parameters: source : `Vector3` frame : `Matrix4x4` viewport : `Viewport` Returns: `Vector3`	Project to the given frame. source : `Vector3` frame : `Matrix4x4` viewport : `Viewport` Returns: `Vector3`
`Viewport.unproject source frame viewport` Full Usage: `Viewport.unproject source frame viewport` Parameters: source : `Vector3` frame : `Matrix4x4` viewport : `Viewport` Returns: `Vector3`	Unproject from the given frame. source : `Vector3` frame : `Matrix4x4` viewport : `Viewport` Returns: `Vector3`