Class Colormap

constructor

• new Colormap(
      opts: {
          external?:
              | {
                  device: GPUDevice;
                  filter: ColormapFilter;
                  sampler: GPUSampler;
                  view: GPUTextureView;
                  width: number;
              }
              | null;
          filter: ColormapFilter;
          label: string;
          rgba8Linear?: Uint8Array<ArrayBufferLike>
          | null;
          width: number;
      },
  ): Colormap

  Parameters

  • opts: {
        external?:
            | {
                device: GPUDevice;
                filter: ColormapFilter;
                sampler: GPUSampler;
                view: GPUTextureView;
                width: number;
            }
            | null;
        filter: ColormapFilter;
        label: string;
        rgba8Linear?: Uint8Array<ArrayBufferLike>
        | null;
        width: number;
    }

  Returns Colormap

Readonlyid

filter

• get filter(): ColormapFilter

  Returns ColormapFilter

width

• get width(): number

  Returns number

getGPUResources

• getGPUResources(device: GPUDevice, queue: GPUQueue): ColormapGPUResources

  Parameters

  • device: GPUDevice
  • queue: GPUQueue

  Returns ColormapGPUResources

toUniformStops

• toUniformStops(maxStops?: number, colorSpace?: "srgb" | "linear"): Color4[]

  Parameters

  • maxStops: number = 8
  • colorSpace: "srgb" | "linear" = "linear"

  Returns Color4[]

Staticbuiltin

• builtin(name: BuiltinColormapName): Colormap

  Parameters

  • name: BuiltinColormapName

  Returns Colormap

StaticfromGPUTextureView

• fromGPUTextureView(
      device: GPUDevice,
      view: GPUTextureView,
      sampler: GPUSampler,
      width: number,
      filter?: ColormapFilter,
  ): Colormap

  Parameters

  • device: GPUDevice
  • view: GPUTextureView
  • sampler: GPUSampler
  • width: number
  • filter: ColormapFilter = "linear"

  Returns Colormap

StaticfromPalette

• fromPalette(colors: readonly Color4[], desc?: ColormapDescriptor): Colormap

  Parameters

  • colors: readonly Color4[]
  • desc: ColormapDescriptor = {}

  Returns Colormap

StaticfromStops

• fromStops(stops: readonly ColormapStop[], desc?: ColormapDescriptor): Colormap

  Parameters

  • stops: readonly ColormapStop[]
  • desc: ColormapDescriptor = {}

  Returns Colormap