Class RenderWebGLAbstract

StatictexColor

StatictexDepthStencil

StatictexNormal

StatictexPosition

StaticadjustAttachments

• 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

Staticassert

• assert<T>(_value: T, _message?: string): 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

StaticbindTexture

• bindTexture(
      _shader: ShaderInterface,
      _texture: WebGLTexture,
      _unit: number,
      _uniform: string,
  ): void

  Parameters

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

  Returns void

Staticclear

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

  Clear the offscreen renderbuffer with the given Color

  Parameters

  • Optional_color: Color
  • _colors: boolean = true
  • _depth: boolean = true
  • _stencil: boolean = true

  Returns void

StaticcreateTexture

• createTexture(_filter: number, _wrap: number): WebGLTexture

  Parameters

  • _filter: number
  • _wrap: number

  Returns WebGLTexture

StaticdrawNode

• drawNode(_node: Node, _cmpCamera: ComponentCamera): void

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

  Parameters

  • _node: Node
  • _cmpCamera: ComponentCamera

  Returns void

StaticgetCanvas

• 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

StaticgetCanvasRectangle

• 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

StaticgetRenderingContext

• getRenderingContext(): WebGL2RenderingContext

  Return a reference to the rendering context

  Returns WebGL2RenderingContext

StaticgetRenderRectangle

• 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

Staticinitialize

• initialize(_antialias?: boolean, _alpha?: boolean): 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

StaticinitializeAttachments

• initializeAttachments(): void

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

  Returns void

Staticpick

• pick(_nodes: readonly Node[], _cmpCamera: ComponentCamera): 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[]

StaticpointRenderToWorld

• pointRenderToWorld(_render: Vector2): 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

StaticresetFramebuffer

• resetFramebuffer(): void

  Reset the framebuffer to the main color buffer.

  Returns void

StaticsetBlendMode

• setBlendMode(_mode: BLEND): void

  Set the blend mode to render with

  Parameters

  • _mode: BLEND

  Returns void

StaticsetCanvasSize

• setCanvasSize(_width: number, _height: number): 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

StaticsetColorWriteMask

• setColorWriteMask(_r: boolean, _g: boolean, _b: boolean, _a: boolean): 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

StaticsetDepthFunction

• setDepthFunction(_function?: DEPTH_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

StaticsetDepthTest

• setDepthTest(_test: boolean): void

  Enable / Disable WebGLs depth test.

  Parameters

  • _test: boolean

  Returns void

StaticsetFramebufferTarget

• setFramebufferTarget(_buffer: WebGLFramebuffer): 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

StaticsetRenderRectangle

• setRenderRectangle(_rect: Rectangle): void

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

  Parameters

  • _rect: Rectangle

  Returns void

StaticsetScissorTest

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

  Enable / Disable WebGLs scissor test.

  Parameters

  • _test: boolean
  • Optional_x: number
  • Optional_y: number
  • Optional_width: number
  • Optional_height: number

  Returns void

StaticsetViewport

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

  Set WebGLs viewport.

  Parameters

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

  Returns void

StaticuseNodeUniforms

• useNodeUniforms(
      _shader: ShaderInterface,
      _mtxWorld: Matrix4x4,
      _mtxPivot: Matrix3x3,
      _color: Color,
      _id?: number,
  ): void

  Parameters

  • _shader: ShaderInterface
  • _mtxWorld: Matrix4x4
  • _mtxPivot: Matrix3x3
  • _color: Color
  • Optional_id: number

  Returns void