Class Viewport

constructor

• new Viewport(width: number, height: number): Viewport

  Parameters

  • width: number

    The width of the viewport.

  • height: number

    The height of the viewport.

  Returns Viewport

Readonlycenter

Readonlyheight

Readonlywidth

dimensions

• get dimensions(): Dimensions.Dimensions

  Returns Dimensions.Dimensions

calculateDrawRect

• calculateDrawRect(image: FrameImageLike): Rectangle.Rectangle

  Computes a rectangle that is scaled correctly to be drawn within the viewport.

  Parameters

  • image: FrameImageLike

    The image to be drawn.

  Returns Rectangle.Rectangle

  A rectangle.

transformNdcPointToViewport

• transformNdcPointToViewport(ndc: Point.Point): Point.Point

  Transforms a normalized device coordinate to a 2D point within the viewport.

  Parameters

  • ndc: Point.Point

    A 2D point in NDC.

  Returns Point.Point

  A 2D point in the coordinate space of the viewport.

transformPointToFrame

• transformPointToFrame(pt: Point.Point, image: FrameImageLike): Point.Point

  Transforms a point in viewport coordinate space to a point in a frame's coordinate space.

  Parameters

  • pt: Point.Point

    A point in viewport coordinate space.

  • image: FrameImageLike

    An image of a frame.

  Returns Point.Point

  A point in the coordinate space of the frame.

transformPointToRay

• transformPointToRay(
      pt: Point.Point,
      image: FrameImageLike,
      camera: FrameCameraBase,
  ): Ray

  Transforms a point in viewport coordinates to a ray.

  For perspective cameras, the returned ray will have an origin that is at the position of the camera with a direction that is pointing into world space away from the camera.

  For orthographic cameras, the returned ray will have an origin that is at the world point of viewport coordinate with a direction that is pointing into world space away from the camera.

  Parameters

  • pt: Point.Point

    A point in viewport coordinates.

  • image: FrameImageLike

    An image of a frame.

  • camera: FrameCameraBase

    A camera used to determine orientation of the scene.

  Returns Ray

  A ray

transformPointToViewport

• transformPointToViewport(pt: Point.Point, image: FrameImageLike): Point.Point

  Parameters

  • pt: Point.Point
  • image: FrameImageLike

  Returns Point.Point

transformPointToWorldSpace

• transformPointToWorldSpace(
      pt: Point.Point,
      depthBuffer: DepthBuffer,
      fallbackNormalizedDepth?: number,
  ): Vector3.Vector3

  Transforms a point in viewport coordinates to a point in world space coordinates. This method expects a depth buffer in order to compute a value for the Z axis.

  Parameters

  • pt: Point.Point

    A point in viewport coordinates.

  • depthBuffer: DepthBuffer

    A depth buffer for computing the Z axis.

  • OptionalfallbackNormalizedDepth: number

    A fallback value if the depth is the max depth value, or cannot be determined.

  Returns Vector3.Vector3

transformScreenPointToNdc

• transformScreenPointToNdc(
      screenPt: Point.Point,
      image: FrameImageLike,
  ): Point.Point

  Maps a screen point to normalized device coordinates (NDC). A screen point at 0,0 represents the top-left of the viewport.

  Parameters

  • screenPt: Point.Point

    A screen point.

  • image: FrameImageLike

  Returns Point.Point

transformVectorToViewport

• transformVectorToViewport(ndc: Vector3.Vector3): Point.Point

  Transforms a normalized device coordinate to a 2D point within the viewport.

  Parameters

  • ndc: Vector3.Vector3

    A 3D point in NDC.

  Returns Point.Point

  A 2D point in the coordinate space of the viewport.

transformWorldToViewport

• transformWorldToViewport(
      worldPt: Vector3.Vector3,
      projectionViewMatrix: Matrix4.Matrix4,
  ): Point.Point

  Transforms a world point to 2D point in viewport space.

  Parameters

  • worldPt: Vector3.Vector3

    The world point to transform.

  • projectionViewMatrix: Matrix4.Matrix4

    The projection matrix to transform a 3D point to 2D point.

  Returns Point.Point

  A point in viewport space.

StaticfromDimensions

• fromDimensions(dimensions: Dimensions.Dimensions): Viewport

  Returns a new viewport with the given dimensions.

  Parameters

  • dimensions: Dimensions.Dimensions

    The dimensions of the viewport

  Returns Viewport

  A new viewport.