Engine API Reference - v2.13.0
    Preparing search index...

    Class WebglGraphicsDevice

    WebglGraphicsDevice extends the base GraphicsDevice to provide rendering capabilities utilizing the WebGL 2.0 specification.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    canvas gpuProfiler insideRenderPass isHdr isNull isWebGPU maxAnisotropy maxColorAttachments maxCubeMapSize maxIndirectDrawCount maxSamples maxTextureSize maxVolumeSize precision samples scope supportsClipDistances supportsCompute supportsMultiDraw supportsStorageTextureRead textureFloatFilterable textureFloatRenderable textureHalfFloatRenderable textureRG11B10Renderable

    Accessors

    deviceType fullscreen height indirectDrawBuffer maxPixelRatio width

    Methods

    clear computeDispatch copyRenderTarget destroy fire getIndirectDrawSlot getRenderableHdrFormat getRenderTarget hasEvent off on once postInit setBlendState setCullMode setDepthState setRenderTarget setScissor setShader setStencilState setViewport validateAttributes

    Constructors

    • Creates a new WebglGraphicsDevice instance.

      Parameters

      • canvas: HTMLCanvasElement

        The canvas to which the graphics device will render.

      • Optionaloptions: {
            alpha?: boolean;
            antialias?: boolean;
            depth?: boolean;
            desynchronized?: boolean;
            failIfMajorPerformanceCaveat?: boolean;
            gl?: WebGL2RenderingContext;
            powerPreference?: "default" | "high-performance" | "low-power";
            premultipliedAlpha?: boolean;
            preserveDrawingBuffer?: boolean;
            stencil?: boolean;
            xrCompatible?: boolean;
        } = {}

        Options passed when creating the WebGL context.

        • Optionalalpha?: boolean

          Boolean that indicates if the canvas contains an alpha buffer. Defaults to true.

        • Optionalantialias?: boolean

          Boolean that indicates whether or not to perform anti-aliasing if possible. Defaults to true.

        • Optionaldepth?: boolean

          Boolean that indicates that the drawing buffer is requested to have a depth buffer of at least 16 bits. Defaults to true.

        • Optionaldesynchronized?: boolean

          Boolean that hints the user agent to reduce the latency by desynchronizing the canvas paint cycle from the event loop. Defaults to false.

        • OptionalfailIfMajorPerformanceCaveat?: boolean

          Boolean that indicates if a context will be created if the system performance is low or if no hardware GPU is available. Defaults to false.

        • Optionalgl?: WebGL2RenderingContext

          The rendering context to use. If not specified, a new context will be created.

        • OptionalpowerPreference?: "default" | "high-performance" | "low-power"

          A hint to the user agent indicating what configuration of GPU is suitable for the WebGL context. Possible values are:

          • 'default': Let the user agent decide which GPU configuration is most suitable. This is the default value.
          • 'high-performance': Prioritizes rendering performance over power consumption.
          • 'low-power': Prioritizes power saving over rendering performance.

          Defaults to 'default'.

        • OptionalpremultipliedAlpha?: boolean

          Boolean that indicates that the page compositor will assume the drawing buffer contains colors with pre-multiplied alpha. Defaults to true.

        • OptionalpreserveDrawingBuffer?: boolean

          If the value is true the buffers will not be cleared and will preserve their values until cleared or overwritten by the author. Defaults to false.

        • Optionalstencil?: boolean

          Boolean that indicates that the drawing buffer is requested to have a stencil buffer of at least 8 bits. Defaults to true.

        • OptionalxrCompatible?: boolean

          Boolean that hints to the user agent to use a compatible graphics adapter for an immersive XR device.

      Returns WebglGraphicsDevice

    Properties

    canvas: HTMLCanvasElement

    The canvas DOM element that provides the underlying WebGL context used by the graphics device.

    gpuProfiler: GpuProfiler

    The GPU profiler.

    insideRenderPass: boolean = false
    isHdr: boolean = false

    True if the back-buffer is using HDR format, which means that the browser will display the rendered images in high dynamic range mode. This is true if the options.displayFormat is set to DISPLAYFORMAT_HDR when creating the graphics device using createGraphicsDevice, and HDR is supported by the device.

    isNull: boolean = false

    True if the deviceType is Null

    isWebGPU: boolean = false

    True if the deviceType is WebGPU

    maxAnisotropy: number

    The maximum supported texture anisotropy setting.

    maxColorAttachments: number = 1

    The maximum supported number of color buffers attached to a render target.

    maxCubeMapSize: number

    The maximum supported dimension of a cube map.

    maxIndirectDrawCount: number = 1024

    The maximum number of indirect draw calls that can be used within a single frame. Used on WebGPU only. This needs to be adjusted based on the maximum number of draw calls that can be used within a single frame. Defaults to 1024.

    maxSamples: number = 1

    The maximum supported number of hardware anti-aliasing samples.

    maxTextureSize: number

    The maximum supported dimension of a texture.

    maxVolumeSize: number

    The maximum supported dimension of a 3D texture (any axis).

    precision: string

    The highest shader precision supported by this graphics device. Can be 'hiphp', 'mediump' or 'lowp'.

    samples: number

    The number of hardware anti-aliasing samples used by the frame buffer.

    scope: ScopeSpace

    The scope namespace for shader attributes and variables.

    supportsClipDistances: boolean = false

    True if the device supports clip distances (WebGPU only). Clip distances allow you to restrict primitives' clip volume with user-defined half-spaces in the output of vertex stage.

    supportsCompute: boolean = false

    True if the device supports compute shaders.

    supportsMultiDraw: boolean = true

    True if the device supports multi-draw. This is always supported on WebGPU, and support on WebGL2 is optional, but pretty common.

    supportsStorageTextureRead: boolean = false

    True if the device can read from StorageTexture in the compute shader. By default, the storage texture can be only used with the write operation. When a shader uses this feature, it's recommended to use a requires directive to signal the potential for non-portability at the top of the WGSL shader code:

    requires readonly_and_readwrite_storage_textures;
    textureFloatFilterable: boolean = false

    True if filtering can be applied when sampling float textures.

    textureFloatRenderable: boolean

    True if 32-bit floating-point textures can be used as a frame buffer.

    textureHalfFloatRenderable: boolean

    True if 16-bit floating-point textures can be used as a frame buffer.

    textureRG11B10Renderable: boolean = false

    True if small-float textures with format PIXELFORMAT_111110F can be used as a frame buffer. This is always true on WebGL2, but optional on WebGPU device.

    Accessors

    Methods

    • Clears the frame buffer of the currently set render target.

      Parameters

      • Optionaloptions: { color?: number[]; depth?: number; flags?: number; stencil?: number }

        Optional options object that controls the behavior of the clear operation defined as follows:

        • Optionalcolor?: number[]

          The color to clear the color buffer to in the range 0 to 1 for each component.

        • Optionaldepth?: number

          The depth value to clear the depth buffer to in the range 0 to 1. Defaults to 1.

        • Optionalflags?: number

          The buffers to clear (the types being color, depth and stencil). Can be any bitwise combination of:

        • Optionalstencil?: number

          The stencil value to clear the stencil buffer to. Defaults to 0.

      Returns void

      // Clear color buffer to black and depth buffer to 1
      device.clear();

      // Clear just the color buffer to red
      device.clear({
          color: [1, 0, 0, 1],
          flags: pc.CLEARFLAG_COLOR
      });

      // Clear color buffer to yellow and depth to 1.0
      device.clear({
          color: [1, 1, 0, 1],
          depth: 1,
          flags: pc.CLEARFLAG_COLOR | pc.CLEARFLAG_DEPTH
      });

    • Copies source render target into destination render target. Mostly used by post-effects.

      Parameters

      • Optionalsource: RenderTarget

        The source render target. Defaults to frame buffer.

      • Optionaldest: RenderTarget

        The destination render target. Defaults to frame buffer.

      • Optionalcolor: boolean

        If true, will copy the color buffer. Defaults to false.

      • Optionaldepth: boolean

        If true, will copy the depth buffer. Defaults to false.

      Returns boolean

      True if the copy was successful, false otherwise.

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Get a renderable HDR pixel format supported by the graphics device.

      Note:

      • When the filterable parameter is set to false, this function returns one of the supported formats on the majority of devices apart from some very old iOS and Android devices (99%).
      • When the filterable parameter is set to true, the function returns a format on a considerably lower number of devices (70%).

      Parameters

      • Optionalformats: number[] = ...

        An array of pixel formats to check for support. Can contain:

      • Optionalfilterable: boolean = true

        If true, the format also needs to be filterable. Defaults to true.

      • Optionalsamples: number = 1

        The number of samples to check for. Some formats are not compatible with multi-sampling, for example PIXELFORMAT_RGBA32F on WebGPU platform. Defaults to 1.

      Returns undefined | number

      The first supported renderable HDR format or undefined if none is supported.

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    • Sets the specified render target on the device. If null is passed as a parameter, the back buffer becomes the current target for all rendering operations.

      Parameters

      • renderTarget: null | RenderTarget

        The render target to activate.

      Returns void

      // Set a render target to receive all rendering output
      device.setRenderTarget(renderTarget);

      // Set the back buffer to receive all rendering output
      device.setRenderTarget(null);

    • Set the active scissor rectangle on the specified device.

      Parameters

      • x: number

        The pixel space x-coordinate of the bottom left corner of the scissor rectangle.

      • y: number

        The pixel space y-coordinate of the bottom left corner of the scissor rectangle.

      • w: number

        The width of the scissor rectangle in pixels.

      • h: number

        The height of the scissor rectangle in pixels.

      Returns void

    • Sets the active shader to be used during subsequent draw calls.

      Parameters

      • shader: Shader

        The shader to assign to the device.

      • OptionalasyncCompile: boolean = false

        If true, rendering will be skipped until the shader is compiled, otherwise the rendering will wait for the shader compilation to finish. Defaults to false.

      Returns void

    • Set the active rectangle for rendering on the specified device.

      Parameters

      • x: number

        The pixel space x-coordinate of the bottom left corner of the viewport.

      • y: number

        The pixel space y-coordinate of the bottom left corner of the viewport.

      • w: number

        The width of the viewport in pixels.

      • h: number

        The height of the viewport in pixels.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods