Small World Engine API Reference - v0.78.00
    Preparing search index...

    Class DeviceCaps

    Per-instance hardware and browser feature detection. Construct one per engine instance (see RendererContext.deviceCaps) so multiple SmallWorlds on one page each get their own, correctly probed capabilities instead of sharing a single process-wide result.

    Index
    constructor
    cores gpuModel gpuVendor memoryGB networkInfo pixelRatio screenHeight screenWidth cores gpuModel gpuVendor memoryGB networkInfo pixelRatio screenHeight screenWidth
    getGuaranteedMinimum getLimit getPerformanceTier hasFeature init isMobile updateLimits getGuaranteedMinimum getLimit getPerformanceTier hasFeature init isMobile updateLimits
    • get gpuModel(): string

      Returns the unmasked GPU model if available.

      Returns string

    • get gpuVendor(): string

      Returns the unmasked GPU vendor if available.

      Returns string

    • get networkInfo(): | {
          downlink: number;
          effectiveType: string;
          saveData: boolean;
      }
      | undefined

      Returns Network Information API data if the browser supports it (Chrome/Edge; absent on Firefox/Safari), or undefined otherwise.

      Returns { downlink: number; effectiveType: string; saveData: boolean } | undefined

    • get cores(): number

      Returns number

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get gpuModel(): string

      Returns string

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get gpuVendor(): string

      Returns string

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get memoryGB(): number

      Returns number

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get networkInfo(): | {
          downlink: number;
          effectiveType: string;
          saveData: boolean;
      }
      | undefined

      Returns { downlink: number; effectiveType: string; saveData: boolean } | undefined

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get pixelRatio(): number

      Returns number

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get screenHeight(): number

      Returns number

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • get screenWidth(): number

      Returns number

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • Returns the spec-guaranteed minimum for limit -- the value every conformant device must support, regardless of what THIS device's getLimit() actually reports. Useful for code that needs to work correctly even on the lowest-common-denominator device, rather than just the one it happened to be tested on (a higher-than-guaranteed value on a dev machine or this project's headless test sandbox has repeatedly masked real budget-overrun bugs that only surfaced on stricter, spec-minimum hardware).

      Parameters

      Returns number

    • Initializes the feature detection. This is called automatically by the Engine, but can be called manually.

      Returns void

    • Returns true if the application is running on a mobile device (phone or tablet).

      Returns boolean

    • Updates hardware limits. Used by renderers to provide more precise values.

      Parameters

      • limits: {
            maxAnisotropy?: number;
            maxFragmentUniformVectors?: number;
            maxMsaaSamples?: number;
            maxTextureImageUnits?: number;
            maxTextureSize?: number;
            maxUniformBufferSize?: number;
            maxVertexUniformVectors?: number;
            webgpuMaxBindGroups?: number;
            webgpuMaxBindingsPerBindGroup?: number;
            webgpuMaxComputeWorkgroupStorageSize?: number;
            webgpuMaxSampledTexturesPerStage?: number;
            webgpuMaxSamplersPerStage?: number;
            webgpuMaxStorageBufferBindingSize?: number;
            webgpuMaxTextureDimension2D?: number;
            webgpuMaxUniformBufferBindingSize?: number;
        }

      Returns void

    • Returns void

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • Returns boolean

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    • Parameters

      • limits: {
            maxAnisotropy?: number;
            maxFragmentUniformVectors?: number;
            maxMsaaSamples?: number;
            maxTextureImageUnits?: number;
            maxTextureSize?: number;
            maxUniformBufferSize?: number;
            maxVertexUniformVectors?: number;
            webgpuMaxBindGroups?: number;
            webgpuMaxBindingsPerBindGroup?: number;
            webgpuMaxComputeWorkgroupStorageSize?: number;
            webgpuMaxSampledTexturesPerStage?: number;
            webgpuMaxSamplersPerStage?: number;
            webgpuMaxStorageBufferBindingSize?: number;
            webgpuMaxTextureDimension2D?: number;
            webgpuMaxUniformBufferBindingSize?: number;
        }

      Returns void

      Use an instance via RendererContext.deviceCaps instead. Removal target: v1.0.0.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods