Class RenderWebGLAbstract

Static texColor

Static texDepthStencil

Static texNormal

Static texPosition

Static adjustAttachments

• adjustAttachments(): void

• Adjusts the size of the different texture attachments (render targets) to the canvas size.

  ⚠️ CAUTION: Expensive operation, use only when canvas size changed.

  Returns void

Static assert

• assert<T>(_value, _message?): T

• Checks the first parameter and throws an exception with the WebGL-errorcode if the value is null

  Type Parameters

  • T

  Parameters

  • _value: T

    value to check against null
  • _message: string = ""

    optional, additional message for the exception

  Returns T

Static bindTexture

• bindTexture(_shader, _texture, _unit, _uniform): void

• Parameters

  • _shader: ShaderInterface
  • _texture: WebGLTexture
  • _unit: number
  • _uniform: string

  Returns void

Static clear

• clear(_color?, _colors?, _depth?, _stencil?): void

• Clear the offscreen renderbuffer with the given Color

  Parameters

  • Optional _color: Color
  • _colors: boolean = true
  • _depth: boolean = true
  • _stencil: boolean = true

  Returns void

Static createTexture

• createTexture(_filter, _wrap): WebGLTexture

• Parameters

  • _filter: number
  • _wrap: number

  Returns WebGLTexture

Static drawNode

• drawNode(_node, _cmpCamera): void

• Draw a mesh buffer using the given infos and the complete projection matrix

  Parameters

  • _node: Node
  • _cmpCamera: ComponentCamera

  Returns void

Static getCanvas

• getCanvas(): HTMLCanvasElement

• Return a reference to the offscreen-canvas.

  • Do not read or modify the canvas dimensions directly.
  • Use getCanvasRectangle to retrieve the size of the offscreen-canvas.
  • Use setCanvasSize to set the size of the offscreen-canvas.

  Returns HTMLCanvasElement

Static getCanvasRectangle

• getCanvasRectangle(): Rectangle

• Returns a reference to the rectangle describing the size of the offscreen-canvas. x,y are 0 at all times.

  Do not modify the rectangle directly, use setCanvasSize instead.

  Returns Rectangle

Static getRenderRectangle

• getRenderRectangle(): Rectangle

• Retrieve the area on the offscreen-canvas the camera image gets rendered to.

  Do not modify the rectangle directly, use setRenderRectangle instead.

  Returns Rectangle

Static getRenderingContext

• getRenderingContext(): WebGL2RenderingContext

• Return a reference to the rendering context

  Returns WebGL2RenderingContext

Static initialize

• initialize(_antialias?, _alpha?): WebGL2RenderingContext

• Initializes offscreen-canvas, renderingcontext and hardware viewport. Call once before creating any resources like meshes or shaders

  Parameters

  • Optional _antialias: boolean
  • Optional _alpha: boolean

  Returns WebGL2RenderingContext

Static initializeAttachments

• initializeAttachments(): void

• Initializes different framebuffers aswell as texture attachments to use as render targets

  Returns void

Static pick

• pick(_nodes, _cmpCamera): Pick[]

• Used with a Picker-camera, this method renders one pixel with picking information for each node in the line of sight and return that as an unsorted Pick-array

  Parameters

  • _nodes: readonly Node[]
  • _cmpCamera: ComponentCamera

  Returns Pick[]

Static pointRenderToWorld

• pointRenderToWorld(_render): Vector3

• Read the (world) position from the pixel at the given point on the render-rectangle (origin top left). ⚠️ CAUTION: Currently only works when ambient occlusion is active due to writing to the position texture being disabled otherwise.

  Parameters

  • _render: Vector2

  Returns Vector3

Static resetFramebuffer

• resetFramebuffer(): void

• Reset the framebuffer to the main color buffer.

  Returns void

Static setBlendMode

• setBlendMode(_mode): void

• Set the blend mode to render with

  Parameters

  • _mode: BLEND

  Returns void

Static setCanvasSize

• setCanvasSize(_width, _height): void

• Set the size of the offscreen-canvas.

  ⚠️ CAUTION: If size changes invokes adjustAttachments which is an expensive operation.

  Parameters

  • _width: number
  • _height: number

  Returns void

Static setColorWriteMask

• setColorWriteMask(_r, _g, _b, _a): void

• Set which color components to enable or to disable when rendering to a color buffer.

  Parameters

  • _r: boolean
  • _g: boolean
  • _b: boolean
  • _a: boolean

  Returns void

Static setDepthFunction

• setDepthFunction(_function?): void

• Set the comparison operation used to test fragment depths against current depth buffer values.

  Parameters

  • _function: DEPTH_FUNCTION = DEPTH_FUNCTION.LESS

  Returns void

Static setDepthTest

• setDepthTest(_test): void

• Enable / Disable WebGLs depth test.

  Parameters

  • _test: boolean

  Returns void

Static setFramebufferTarget

• setFramebufferTarget(_buffer): void

• Set the final framebuffer to render to. If null, the canvas default framebuffer is used. Used by XR to render to the XRWebGLLayer framebuffer.

  Parameters

  • _buffer: WebGLFramebuffer

  Returns void

Static setRenderRectangle

• setRenderRectangle(_rect): void

• Set the area on the offscreen-canvas to render the camera image to.

  Parameters

  • _rect: Rectangle

  Returns void

Static setScissorTest

• setScissorTest(_test, _x?, _y?, _width?, _height?): void

• Enable / Disable WebGLs scissor test.

  Parameters

  • _test: boolean
  • Optional _x: number
  • Optional _y: number
  • Optional _width: number
  • Optional _height: number

  Returns void

Static setViewport

• setViewport(_x, _y, _width, _height): void

• Set WebGLs viewport.

  Parameters

  • _x: number
  • _y: number
  • _width: number
  • _height: number

  Returns void

Static useNodeUniforms

• useNodeUniforms(_shader, _mtxWorld, _mtxPivot, _color, _id?): void

• Parameters

  • _shader: ShaderInterface
  • _mtxWorld: Matrix4x4
  • _mtxPivot: Matrix3x3
  • _color: Color
  • Optional _id: number

  Returns void