visgl/luma.gl | Build 8051293999 | modules/webgl/src/adapter/converters/texture-formats.ts | Coveralls

1

// luma.gl, MIT license

1✔

2

// Copyright (c) vis.gl contributors

1✔

3

1✔

4

import type {TextureFormat, DeviceFeature} from '@luma.gl/core';

1✔

5

import {decodeTextureFormat} from '@luma.gl/core';

1✔

6

import {GL, GLExtensions} from '@luma.gl/constants';

1✔

7

import {getWebGLExtension} from '../../context/helpers/webgl-extensions';

1✔

8

import {getGLFromVertexType} from './vertex-formats';

1✔

9

1✔

10

/* eslint-disable camelcase */

1✔

11

1✔

12

// TEXTURE FEATURES

1✔

13

1✔

14

// Define local device feature strings to optimize minification

1✔

15

const texture_compression_bc: DeviceFeature = 'texture-compression-bc';

1✔

16

const texture_compression_astc: DeviceFeature = 'texture-compression-astc';

1✔

17

const texture_compression_etc2: DeviceFeature = 'texture-compression-etc2';

1✔

18

const texture_compression_etc1_webgl: DeviceFeature = 'texture-compression-etc1-webgl';

1✔

19

const texture_compression_pvrtc_webgl: DeviceFeature = 'texture-compression-pvrtc-webgl';

1✔

20

const texture_compression_atc_webgl: DeviceFeature = 'texture-compression-atc-webgl';

1✔

21

1✔

22

// const float32_renderable_webgl: DeviceFeature = 'float32-renderable-webgl';

1✔

23

// const float16_renderable_webgl: DeviceFeature = 'float16-renderable-webgl';

1✔

24

1✔

25

// Define local webgl extension strings to optimize minification

1✔

26

const X_S3TC = 'WEBGL_compressed_texture_s3tc'; // BC1, BC2, BC3

1✔

27

const X_S3TC_SRGB = 'WEBGL_compressed_texture_s3tc_srgb'; // BC1, BC2, BC3

1✔

28

const X_RGTC = 'EXT_texture_compression_rgtc'; // BC4, BC5

1✔

29

const X_BPTC = 'EXT_texture_compression_bptc'; // BC6, BC7

1✔

30

const X_ETC2 = 'WEBGL_compressed_texture_etc'; // Renamed from 'WEBGL_compressed_texture_es3'

1✔

31

const X_ASTC = 'WEBGL_compressed_texture_astc';

1✔

32

const X_ETC1 = 'WEBGL_compressed_texture_etc1';

1✔

33

const X_PVRTC = 'WEBGL_compressed_texture_pvrtc';

1✔

34

const X_ATC = 'WEBGL_compressed_texture_atc';

1✔

35

1✔

36

// Define local webgl extension strings to optimize minification

1✔

37

const EXT_texture_norm16 = 'EXT_texture_norm16';

1✔

38

const EXT_color_buffer_float = 'EXT_color_buffer_float';

1✔

39

// const EXT_HALF_FLOAT_WEBGL1 = 'EXT_color_buffer_half_float';

1✔

40

1✔

41

// prettier-ignore

1✔

42

export const TEXTURE_FEATURES: Partial<Record<DeviceFeature, string[]>> = {

1✔

43

  'float32-renderable-webgl': ['EXT_color_buffer_float'], // [false, 'EXT_color_buffer_float'],

1✔

44

  'float16-renderable-webgl': ['EXT_color_buffer_half_float'],

1✔

45

  'norm16-renderable-webgl': [EXT_texture_norm16],

1✔

46

1✔

47

  'float32-filterable': ['OES_texture_float_linear'],

1✔

48

  'float16-filterable-webgl': ['OES_texture_half_float_linear'],

1✔

49

  'texture-filterable-anisotropic-webgl': ['EXT_texture_filter_anisotropic'],

1✔

50

1✔

51

  'texture-blend-float-webgl': ['EXT_float_blend'],

1✔

52

1✔

53

  'texture-compression-bc': [X_S3TC, X_S3TC_SRGB, X_RGTC, X_BPTC],

1✔

54

  // 'texture-compression-bc3-srgb-webgl': [X_S3TC_SRGB],

1✔

55

  // 'texture-compression-bc3-webgl': [X_S3TC],

1✔

56

  'texture-compression-bc5-webgl': [X_RGTC],

1✔

57

  'texture-compression-bc7-webgl': [X_BPTC],

1✔

58

  'texture-compression-etc2': [X_ETC2],

1✔

59

  'texture-compression-astc': [X_ASTC],

1✔

60

  'texture-compression-etc1-webgl': [X_ETC1],

1✔

61

  'texture-compression-pvrtc-webgl': [X_PVRTC],

1✔

62

  'texture-compression-atc-webgl': [X_ATC]

1✔

63

};

1✔

64

1✔

65

/** Return a list of texture feature strings (for Device.features). Mainly compressed texture support */

1✔

66

// export function getTextureFeatures(

1✔

67

//   gl: WebGL2RenderingContext,

1✔

68

//   extensions: GLExtensions

1✔

69

// ): DeviceFeature[] {

1✔

70

//   const textureFeatures = Object.keys(TEXTURE_FEATURES) as DeviceFeature[];

1✔

71

//   return textureFeatures.filter(feature => checkTextureFeature(gl, feature, extensions));

1✔

72

// }

1✔

73

1✔

74

export function isTextureFeature(feature: DeviceFeature): boolean {

1✔

75

  return feature in TEXTURE_FEATURES;

30✔

76

30✔

77

1✔

78

/** Checks a texture feature (for Device.features). Mainly compressed texture support */

1✔

79

export function checkTextureFeature(

1✔

80

  gl: WebGL2RenderingContext,

15✔

81

  feature: DeviceFeature,

15✔

82

  extensions: GLExtensions

15✔

83

): boolean {

15✔

85

  return textureExtensions.every(extension => getWebGLExtension(gl, extension, extensions));

15✔

86

15✔

87

1✔

88

// TEXTURE FORMATS

1✔

89

1✔

90

/** Map a format to webgl and constants */

1✔

91

type Format = {

1✔

92

  gl?: GL;

1✔

93

  /** format requires WebGL2, when using a WebGL 1 context, color renderbuffer formats are limited */

1✔

94

  gl2ext?: string;

1✔

95

1✔

96

  /** (bytes per pixel), for memory usage calculations. */

1✔

97

  b?: number;

1✔

98

  /** channels */

1✔

99

  c?: number;

1✔

100

  bpp?: number;

1✔

101

  /** packed */

1✔

102

  p?: number;

1✔

103

  /** compressed */

1✔

104

  x?: string;

1✔

105

  /** for compressed texture formats */

1✔

106

  f?: DeviceFeature;

1✔

107

  /** renderable if feature is present */

1✔

108

  render?: DeviceFeature;

1✔

109

  /** filterable if feature is present */

1✔

110

  filter?: DeviceFeature;

1✔

111

1✔

112

  /** If not supported on WebGPU */

1✔

113

  wgpu?: false;

1✔

114

1✔

115

  types?: number[];

1✔

116

1✔

117

  dataFormat?: GL;

1✔

118

  /** Depth and stencil format attachment points. If set, needs to be a Renderbuffer unless depthTexture is set  */

1✔

119

  attachment?: GL.DEPTH_ATTACHMENT | GL.STENCIL_ATTACHMENT | GL.DEPTH_STENCIL_ATTACHMENT;

1✔

120

  /** if depthTexture is set this is a depth/stencil format that can be set to a texture  */

1✔

121

  depthTexture?: boolean;

1✔

122

1✔

123

  renderbuffer?: boolean;

1✔

124

};

1✔

125

1✔

126

// TABLES

1✔

127

1✔

128

/**

1✔

129

 * Texture format data -

1✔

130

 * Exported but can change without notice

1✔

131

*/

1✔

132

// prettier-ignore

1✔

133

export const TEXTURE_FORMATS: Record<TextureFormat, Format> = {

1✔

134

  // Unsized formats that leave the precision up to the driver.

1✔

135

  // TODO - Fix bpp constants

1✔

136

  // 'r8unorm-unsized': {gl: GL.LUMINANCE, b: 4, c: 2, bpp: 4},

1✔

137

  'rgb8unorm-unsized': {gl: GL.RGB, b: 4, c: 2, bpp: 4,

1✔

138

    dataFormat: GL.RGB, types: [GL.UNSIGNED_BYTE, GL.UNSIGNED_SHORT_5_6_5]},

1✔

139

  'rgba8unorm-unsized': {gl: GL.RGBA, b: 4, c: 2, bpp: 4,

1✔

140

    dataFormat: GL.RGBA, types: [GL.UNSIGNED_BYTE, GL.UNSIGNED_SHORT_4_4_4_4, GL.UNSIGNED_SHORT_5_5_5_1]},

1✔

141

  // 'rgb8unorm-srgb-unsized': {gl: GL.SRGB_EXT, b: 4, c: 2, bpp: 4, gl1Ext: SRGB},

1✔

142

  // 'rgba8unorm-srgb-unsized': {gl: GL.SRGB_ALPHA_EXT, b: 4, c: 2, bpp: 4, gl1Ext: SRGB},

1✔

143

1✔

144

  // 8-bit formats

1✔

145

  'r8unorm': {gl: GL.R8, b: 1, c: 1, renderbuffer: true},

1✔

146

  'r8snorm': {gl: GL.R8_SNORM, b: 1, c: 1},

1✔

147

  'r8uint': {gl: GL.R8UI, b: 1, c: 1, renderbuffer: true},

1✔

148

  'r8sint': {gl: GL.R8I, b: 1, c: 1, renderbuffer: true},

1✔

149

1✔

150

  // 16-bit formats

1✔

151

  'rg8unorm': {gl: GL.RG8, b: 2, c: 2, renderbuffer: true},

1✔

152

  'rg8snorm': {gl: GL.RG8_SNORM, b: 2, c: 2},

1✔

153

  'rg8uint': {gl: GL.RG8UI, b: 2, c: 2, renderbuffer: true},

1✔

154

  'rg8sint': {gl: GL.RG8I, b: 2, c: 2, renderbuffer: true},

1✔

155

1✔

156

  'r16uint': {gl: GL.R16UI, b: 2, c: 1, renderbuffer: true},

1✔

157

  'r16sint': {gl: GL.R16I, b: 2, c: 1, renderbuffer: true},

1✔

158

  'r16float': {gl: GL.R16F, b: 2, c: 1, render: 'float16-renderable-webgl', filter: 'float16-filterable-webgl', renderbuffer: true},

1✔

159

  'r16unorm-webgl': {gl: GL.R16_EXT, b:2, c:1, f: 'norm16-renderable-webgl', renderbuffer: true, x: EXT_texture_norm16},

1✔

160

  'r16snorm-webgl': {gl: GL.R16_SNORM_EXT, b:2, c:1, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

161

1✔

162

  // Packed 16-bit formats

1✔

163

  'rgba4unorm-webgl': {gl: GL.RGBA4, b: 2, c: 4, wgpu: false, renderbuffer: true},

1✔

164

  'rgb565unorm-webgl': {gl: GL.RGB565, b: 2, c: 4, wgpu: false, renderbuffer: true},

1✔

165

  'rgb5a1unorm-webgl': {gl: GL.RGB5_A1, b: 2, c: 4, wgpu: false, renderbuffer: true},

1✔

166

1✔

167

  // 24-bit formats

1✔

168

  'rgb8unorm-webgl': {gl: GL.RGB8, b: 3, c: 3, wgpu: false},

1✔

169

  'rgb8snorm-webgl': {gl: GL.RGB8_SNORM, b: 3, c: 3, wgpu: false},

1✔

170

1✔

171

  // 32-bit formats

1✔

172

  'rgba8unorm': {gl: GL.RGBA8, b: 4, c: 2, bpp: 4},

1✔

173

  'rgba8unorm-srgb': {gl: GL.SRGB8_ALPHA8, b: 4, c: 4, bpp: 4},

1✔

174

  'rgba8snorm': {gl: GL.RGBA8_SNORM, b: 4, c: 4},

1✔

175

  'rgba8uint': {gl: GL.RGBA8UI, b: 4, c: 4, bpp: 4},

1✔

176

  'rgba8sint': {gl: GL.RGBA8I, b: 4, c: 4, bpp: 4},

1✔

177

  // reverse colors, webgpu only

1✔

178

  'bgra8unorm': {b: 4, c: 4},

1✔

179

  'bgra8unorm-srgb': {b: 4, c: 4},

1✔

180

1✔

181

  'rg16uint': {gl: GL.RG16UI, b: 4, c: 1, bpp: 4},

1✔

182

  'rg16sint': {gl: GL.RG16I, b: 4, c: 2, bpp: 4},

1✔

183

  // When using a WebGL 2 context and the EXT_color_buffer_float WebGL2 extension

1✔

184

  'rg16float': {gl: GL.RG16F, bpp: 4, b: 4, c: 2, render: 'float16-renderable-webgl', filter: 'float16-filterable-webgl', renderbuffer: true},

1✔

185

  'rg16unorm-webgl': {gl: GL.RG16_EXT, b:2, c:2, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

186

  'rg16snorm-webgl': {gl: GL.RG16_SNORM_EXT, b:2, c:2, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

187

1✔

188

  'r32uint': {gl: GL.R32UI, b: 4, c: 1, bpp: 4, renderbuffer: true},

1✔

189

  'r32sint': {gl: GL.R32I, b: 4, c: 1, bpp: 4, renderbuffer: true},

1✔

190

  'r32float': {gl: GL.R32F, bpp: 4, b: 4, c: 1, render: 'float32-renderable-webgl', filter: 'float32-filterable'},

1✔

191

1✔

192

  // Packed 32-bit formats

1✔

193

  'rgb9e5ufloat': {gl: GL.RGB9_E5, b: 4, c: 3, p: 1, render: 'float16-renderable-webgl', filter: 'float16-filterable-webgl'},

1✔

194

  'rg11b10ufloat': {gl: GL.R11F_G11F_B10F, b: 4, c: 3, p: 1,render: 'float32-renderable-webgl', renderbuffer: true},

1✔

195

  'rgb10a2unorm': {gl: GL.RGB10_A2, b: 4, c: 4, p: 1, renderbuffer: true},

1✔

196

  'rgb10a2unorm-webgl': {b: 4, c: 4, gl: GL.RGB10_A2UI, p: 1, wgpu: false, bpp: 4, renderbuffer: true},

1✔

197

1✔

198

  // 48-bit formats

1✔

199

  'rgb16unorm-webgl': {gl: GL.RGB16_EXT, b:2, c:3, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

200

  'rgb16snorm-webgl': {gl: GL.RGB16_SNORM_EXT, b:2, c:3, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

201

1✔

202

  // 64-bit formats

1✔

203

  'rg32uint': {gl: GL.RG32UI, b: 8, c: 2, renderbuffer: true},

1✔

204

  'rg32sint': {gl: GL.RG32I, b: 8, c: 2, renderbuffer: true},

1✔

205

  'rg32float': {gl: GL.RG32F, b: 8, c: 2, render: 'float32-renderable-webgl', filter: 'float32-filterable', renderbuffer: true},

1✔

206

  'rgba16uint': {gl: GL.RGBA16UI, b: 8, c: 4, renderbuffer: true},

1✔

207

  'rgba16sint': {gl: GL.RGBA16I, b: 8, c: 4, renderbuffer: true},

1✔

208

  'rgba16float': {gl: GL.RGBA16F, b: 8, c: 4, render: 'float16-renderable-webgl', filter: 'float16-filterable-webgl'},

1✔

209

  'rgba16unorm-webgl': {gl: GL.RGBA16_EXT, b:2, c:4, f: 'norm16-renderable-webgl', renderbuffer: true, x: EXT_texture_norm16},

1✔

210

  'rgba16snorm-webgl': {gl: GL.RGBA16_SNORM_EXT, b:2, c:4, f: 'norm16-renderable-webgl', x: EXT_texture_norm16},

1✔

211

1✔

212

  // 96-bit formats (deprecated!)

1✔

213

  'rgb32float-webgl': {gl: GL.RGB32F, render: 'float32-renderable-webgl', filter: 'float32-filterable',

1✔

214

    gl2ext: EXT_color_buffer_float, dataFormat: GL.RGB, types: [GL.FLOAT]},

1✔

215

1✔

216

  // 128-bit formats

1✔

217

  'rgba32uint': {gl: GL.RGBA32UI, b: 16, c: 4, renderbuffer: true},

1✔

218

  'rgba32sint': {gl: GL.RGBA32I, b: 16, c: 4, renderbuffer: true},

1✔

219

  'rgba32float': {gl: GL.RGBA32F, b: 16, c: 4, render: 'float32-renderable-webgl', filter: 'float32-filterable', renderbuffer: true},

1✔

220

1✔

221

  // Depth and stencil formats

1✔

222

  'stencil8': {gl: GL.STENCIL_INDEX8, b: 1, c: 1, attachment: GL.STENCIL_ATTACHMENT, renderbuffer: true}, // 8 stencil bits

1✔

223

1✔

224

  'depth16unorm': {gl: GL.DEPTH_COMPONENT16, b: 2, c: 1, attachment: GL.DEPTH_ATTACHMENT, renderbuffer: true}, // 16 depth bits

1✔

225

  'depth24plus': {gl: GL.DEPTH_COMPONENT24, b: 3, c: 1, attachment: GL.DEPTH_ATTACHMENT},

1✔

226

  'depth32float': {gl: GL.DEPTH_COMPONENT32F, b: 4, c: 1, attachment: GL.DEPTH_ATTACHMENT, renderbuffer: true},

1✔

227

1✔

228

  // The depth component of the "depth24plus" and "depth24plus-stencil8" formats may be implemented as either a 24-bit depth value or a "depth32float" value.

1✔

229

  'depth24plus-stencil8': {gl: GL.DEPTH_STENCIL, b: 4, c: 2, p: 1, attachment: GL.DEPTH_STENCIL_ATTACHMENT, renderbuffer: true, depthTexture: true},

1✔

230

  // "depth24unorm-stencil8" feature

1✔

231

  'depth24unorm-stencil8': {gl: GL.DEPTH24_STENCIL8, b: 4, c: 2, p: 1, attachment: GL.DEPTH_STENCIL_ATTACHMENT, renderbuffer: true},

1✔

232

  // "depth32float-stencil8" feature

1✔

233

  'depth32float-stencil8': {gl: GL.DEPTH32F_STENCIL8, b: 5, c: 2, p: 1, attachment: GL.DEPTH_STENCIL_ATTACHMENT, renderbuffer: true},

1✔

234

1✔

235

  // BC compressed formats: check device.features.has("texture-compression-bc");

1✔

236

1✔

237

  'bc1-rgb-unorm-webgl': {gl: GL.COMPRESSED_RGB_S3TC_DXT1_EXT, x: X_S3TC, f: texture_compression_bc},

1✔

238

  'bc1-rgb-unorm-srgb-webgl': {gl: GL.COMPRESSED_SRGB_S3TC_DXT1_EXT, x: X_S3TC_SRGB, f: texture_compression_bc},

1✔

239

1✔

240

  'bc1-rgba-unorm': {gl: GL.COMPRESSED_RGBA_S3TC_DXT1_EXT, x: X_S3TC, f: texture_compression_bc},

1✔

241

  'bc1-rgba-unorm-srgb': {gl: GL.COMPRESSED_SRGB_S3TC_DXT1_EXT, x: X_S3TC_SRGB, f: texture_compression_bc},

1✔

242

  'bc2-rgba-unorm': {gl: GL.COMPRESSED_RGBA_S3TC_DXT3_EXT, x: X_S3TC, f: texture_compression_bc},

1✔

243

  'bc2-rgba-unorm-srgb': {gl: GL.COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT, x: X_S3TC_SRGB, f: texture_compression_bc},

1✔

244

  'bc3-rgba-unorm': {gl: GL.COMPRESSED_RGBA_S3TC_DXT5_EXT, x: X_S3TC, f: texture_compression_bc},

1✔

245

  'bc3-rgba-unorm-srgb': {gl: GL.COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT, x: X_S3TC_SRGB, f: texture_compression_bc},

1✔

246

  'bc4-r-unorm': {gl: GL.COMPRESSED_RED_RGTC1_EXT, x: X_RGTC, f: texture_compression_bc},

1✔

247

  'bc4-r-snorm': {gl: GL.COMPRESSED_SIGNED_RED_RGTC1_EXT, x: X_RGTC, f: texture_compression_bc},

1✔

248

  'bc5-rg-unorm': {gl: GL.COMPRESSED_RED_GREEN_RGTC2_EXT, x: X_RGTC, f: texture_compression_bc},

1✔

249

  'bc5-rg-snorm': {gl: GL.COMPRESSED_SIGNED_RED_GREEN_RGTC2_EXT, x: X_RGTC, f: texture_compression_bc},

1✔

250

  'bc6h-rgb-ufloat': {gl: GL.COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT_EXT, x: X_BPTC, f: texture_compression_bc},

1✔

251

  'bc6h-rgb-float': {gl: GL.COMPRESSED_RGB_BPTC_SIGNED_FLOAT_EXT, x: X_BPTC, f: texture_compression_bc},

1✔

252

  'bc7-rgba-unorm': {gl: GL.COMPRESSED_RGBA_BPTC_UNORM_EXT, x: X_BPTC, f: texture_compression_bc},

1✔

253

  'bc7-rgba-unorm-srgb': {gl: GL.COMPRESSED_SRGB_ALPHA_BPTC_UNORM_EXT, x: X_BPTC, f: texture_compression_bc},

1✔

254

1✔

255

  // WEBGL_compressed_texture_etc: device.features.has("texture-compression-etc2")

1✔

256

  // Note: Supposedly guaranteed availability compressed formats in WebGL2, but through CPU decompression

1✔

257

1✔

258

  'etc2-rgb8unorm': {gl: GL.COMPRESSED_RGB8_ETC2, f: texture_compression_etc2},

1✔

259

  'etc2-rgb8unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ETC2, f: texture_compression_etc2},

1✔

260

  'etc2-rgb8a1unorm': {gl: GL.COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2, f: texture_compression_etc2},

1✔

261

  'etc2-rgb8a1unorm-srgb': {gl: GL.COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2, f: texture_compression_etc2},

1✔

262

  'etc2-rgba8unorm': {gl: GL.COMPRESSED_RGBA8_ETC2_EAC, f: texture_compression_etc2},

1✔

263

  'etc2-rgba8unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ETC2_EAC, f: texture_compression_etc2},

1✔

264

1✔

265

  'eac-r11unorm': {gl: GL.COMPRESSED_R11_EAC, f: texture_compression_etc2},

1✔

266

  'eac-r11snorm': {gl: GL.COMPRESSED_SIGNED_R11_EAC, f: texture_compression_etc2},

1✔

267

  'eac-rg11unorm': {gl: GL.COMPRESSED_RG11_EAC, f: texture_compression_etc2},

1✔

268

  'eac-rg11snorm': {gl: GL.COMPRESSED_SIGNED_RG11_EAC, f: texture_compression_etc2},

1✔

269

1✔

270

  // X_ASTC compressed formats: device.features.has("texture-compression-astc")

1✔

271

1✔

272

  'astc-4x4-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_4x4_KHR, f: texture_compression_astc},

1✔

273

  'astc-4x4-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR, f: texture_compression_astc},

1✔

274

  'astc-5x4-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_5x4_KHR, f: texture_compression_astc},

1✔

275

  'astc-5x4-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR, f: texture_compression_astc},

1✔

276

  'astc-5x5-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_5x5_KHR, f: texture_compression_astc},

1✔

277

  'astc-5x5-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR, f: texture_compression_astc},

1✔

278

  'astc-6x5-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_6x5_KHR, f: texture_compression_astc},

1✔

279

  'astc-6x5-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR, f: texture_compression_astc},

1✔

280

  'astc-6x6-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_6x6_KHR, f: texture_compression_astc},

1✔

281

  'astc-6x6-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR, f: texture_compression_astc},

1✔

282

  'astc-8x5-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_8x5_KHR, f: texture_compression_astc},

1✔

283

  'astc-8x5-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR, f: texture_compression_astc},

1✔

284

  'astc-8x6-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_8x6_KHR, f: texture_compression_astc},

1✔

285

  'astc-8x6-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR, f: texture_compression_astc},

1✔

286

  'astc-8x8-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_8x8_KHR, f: texture_compression_astc},

1✔

287

  'astc-8x8-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR, f: texture_compression_astc},

1✔

288

  'astc-10x5-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_10x10_KHR, f: texture_compression_astc},

1✔

289

  'astc-10x5-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR, f: texture_compression_astc},

1✔

290

  'astc-10x6-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_10x6_KHR, f: texture_compression_astc},

1✔

291

  'astc-10x6-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR, f: texture_compression_astc},

1✔

292

  'astc-10x8-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_10x8_KHR, f: texture_compression_astc},

1✔

293

  'astc-10x8-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR, f: texture_compression_astc},

1✔

294

  'astc-10x10-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_10x10_KHR, f: texture_compression_astc},

1✔

295

  'astc-10x10-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR, f: texture_compression_astc},

1✔

296

  'astc-12x10-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_12x10_KHR, f: texture_compression_astc},

1✔

297

  'astc-12x10-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR, f: texture_compression_astc},

1✔

298

  'astc-12x12-unorm': {gl: GL.COMPRESSED_RGBA_ASTC_12x12_KHR, f: texture_compression_astc},

1✔

299

  'astc-12x12-unorm-srgb': {gl: GL.COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR, f: texture_compression_astc},

1✔

300

1✔

301

  // WEBGL_compressed_texture_pvrtc

1✔

302

1✔

303

  'pvrtc-rgb4unorm-webgl': {gl: GL.COMPRESSED_RGB_PVRTC_4BPPV1_IMG, f: texture_compression_pvrtc_webgl},

1✔

304

  'pvrtc-rgba4unorm-webgl': {gl: GL.COMPRESSED_RGBA_PVRTC_4BPPV1_IMG, f: texture_compression_pvrtc_webgl},

1✔

305

  'pvrtc-rbg2unorm-webgl': {gl: GL.COMPRESSED_RGB_PVRTC_2BPPV1_IMG, f: texture_compression_pvrtc_webgl},

1✔

306

  'pvrtc-rgba2unorm-webgl': {gl: GL.COMPRESSED_RGBA_PVRTC_2BPPV1_IMG, f: texture_compression_pvrtc_webgl},

1✔

307

1✔

308

  // WEBGL_compressed_texture_etc1

1✔

309

1✔

310

  'etc1-rbg-unorm-webgl': {gl: GL.COMPRESSED_RGB_ETC1_WEBGL, f: texture_compression_etc1_webgl},

1✔

311

1✔

312

  // WEBGL_compressed_texture_atc

1✔

313

1✔

314

  'atc-rgb-unorm-webgl': {gl: GL.COMPRESSED_RGB_ATC_WEBGL, f: texture_compression_atc_webgl},

1✔

315

  'atc-rgba-unorm-webgl': {gl: GL.COMPRESSED_RGBA_ATC_EXPLICIT_ALPHA_WEBGL, f: texture_compression_atc_webgl},

1✔

316

  'atc-rgbai-unorm-webgl': {gl: GL.COMPRESSED_RGBA_ATC_INTERPOLATED_ALPHA_WEBGL, f: texture_compression_atc_webgl}

1✔

317

};

1✔

318

1✔

319

/** Legal combinations for internalFormat, format and type *

1✔

320

// [GL.DEPTH_COMPONENT]: {types: [GL.UNSIGNED_SHORT, GL.UNSIGNED_INT, GL.UNSIGNED_INT_24_8]},

1✔

321

// [GL.DEPTH_STENCIL]: ,

1✔

322

// Sized texture format

1✔

323

// R

1✔

324

[GL.R8]: {dataFormat: GL.RED, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

325

[GL.R16F]: {dataFormat: GL.RED, types: [GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

326

[GL.R8UI]: {dataFormat: GL.RED_INTEGER, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

327

// // RG

1✔

328

[GL.RG8]: {dataFormat: GL.RG, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

329

[GL.RG16F]: {dataFormat: GL.RG, types: [GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

330

[GL.RG8UI]: {dataFormat: GL.RG_INTEGER, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

331

// // RGB

1✔

332

[GL.RGB8]: {dataFormat: GL.RGB, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

333

[GL.SRGB8]: {dataFormat: GL.RGB, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

334

[GL.RGB16F]: {dataFormat: GL.RGB, types: [GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

335

[GL.RGB8UI]: {dataFormat: GL.RGB_INTEGER, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

336

// // RGBA

1✔

337

1✔

338

[GL.RGB565]: {dataFormat: GL.RGB, types: [GL.UNSIGNED_BYTE, GL.UNSIGNED_SHORT_5_6_5], gl2: true},

1✔

339

[GL.R11F_G11F_B10F]: {dataFormat: GL.RGB, types: [GL.UNSIGNED_INT_10F_11F_11F_REV, GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

340

[GL.RGB9_E5]: {dataFormat: GL.RGB, types: [GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

341

[GL.RGBA8]: {dataFormat: GL.RGBA, types: [GL.UNSIGNED_BYTE], gl2: true},

1✔

342

[GL.SRGB8_ALPHA8]: {dataFormat: GL.RGBA, types: [GL.UNSIGNED_BYTE], gl2: true, gl1ext: EXT_SRGB},

1✔

343

[GL.RGB5_A1]: {dataFormat: GL.RGBA, types: [GL.UNSIGNED_BYTE, GL.UNSIGNED_SHORT_5_5_5_1], gl2: true},

1✔

344

[GL.RGBA4]: {dataFormat: GL.RGBA, types: [GL.UNSIGNED_BYTE, GL.UNSIGNED_SHORT_4_4_4_4], gl2: true},

1✔

345

[GL.RGBA16F]: {dataFormat: GL.RGBA, types: [GL.HALF_FLOAT, GL.FLOAT], gl2: true},

1✔

346

[GL.RGBA8UI]: {dataFormat: GL.RGBA_INTEGER, types: [GL.UNSIGNED_BYTE], gl2: true}

1✔

347

*/

1✔

348

1✔

349

/* This table is now baked into the above table

1✔

350

type RenderbufferFormat = {

1✔

351

  bpp: number;

1✔

352

  gl2?: boolean;

1✔

353

  ext?: string;

1✔

354

};

1✔

355

1✔

356

export const RENDERBUFFER_FORMATS: Record<string, RenderbufferFormat> = {

1✔

357

  [GL.DEPTH_COMPONENT16]: {bpp: 2}, // 16 depth bits.

1✔

358

  // TODO - Not clear which webgpu value to map this to.

1✔

359

  // [GL.DEPTH_COMPONENT24]: {gl2: true, bpp: 3},

1✔

360

  [GL.DEPTH_COMPONENT32F]: {gl2: true, bpp: 4},

1✔

361

1✔

362

  [GL.STENCIL_INDEX8]: {bpp: 1}, // 8 stencil bits.

1✔

363

1✔

364

  [GL.DEPTH_STENCIL]: {bpp: 4},

1✔

365

  [GL.DEPTH24_STENCIL8]: {gl2: true, bpp: 4},

1✔

366

  [GL.DEPTH32F_STENCIL8]: {gl2: true, bpp: 5},

1✔

367

1✔

368

  // When using a WebGL 1 context, color renderbuffer formats are limited

1✔

369

  [GL.RGBA4]: {gl2: true, bpp: 2},

1✔

370

  [GL.RGB565]: {gl2: true, bpp: 2},

1✔

371

  [GL.RGB5_A1]: {gl2: true, bpp: 2},

1✔

372

1✔

373

  // When using a WebGL 2 context, the following values are available additionally:

1✔

374

  [GL.R8]: {gl2: true, bpp: 1},

1✔

375

  [GL.R8UI]: {gl2: true, bpp: 1},

1✔

376

  [GL.R8I]: {gl2: true, bpp: 1},

1✔

377

  [GL.R16UI]: {gl2: true, bpp: 2},

1✔

378

  [GL.R16I]: {gl2: true, bpp: 2},

1✔

379

  [GL.R32UI]: {gl2: true, bpp: 4},

1✔

380

  [GL.R32I]: {gl2: true, bpp: 4},

1✔

381

  [GL.RG8]: {gl2: true, bpp: 2},

1✔

382

  [GL.RG8UI]: {gl2: true, bpp: 2},

1✔

383

  [GL.RG8I]: {gl2: true, bpp: 2},

1✔

384

  [GL.RG16UI]: {gl2: true, bpp: 4},

1✔

385

  [GL.RG16I]: {gl2: true, bpp: 4},

1✔

386

  [GL.RG32UI]: {gl2: true, bpp: 8},

1✔

387

  [GL.RG32I]: {gl2: true, bpp: 8},

1✔

388

  [GL.RGB8]: {gl2: true, bpp: 3},

1✔

389

  [GL.RGBA8]: {gl2: true, bpp: 4},

1✔

390

  // [GL.SRGB8_ALPHA8]: {gl2: true, gl1: SRGB}, // When using the EXT_sRGB WebGL1 extension

1✔

391

  [GL.RGB10_A2]: {gl2: true, bpp: 4},

1✔

392

  [GL.RGBA8UI]: {gl2: true, bpp: 4},

1✔

393

  [GL.RGBA8I]: {gl2: true, bpp: 4},

1✔

394

  [GL.RGB10_A2UI]: {gl2: true, bpp: 4},

1✔

395

  [GL.RGBA16UI]: {gl2: true, bpp: 8},

1✔

396

  [GL.RGBA16I]: {gl2: true, bpp: 8},

1✔

397

  [GL.RGBA32I]: {gl2: true, bpp: 16},

1✔

398

  [GL.RGBA32UI]: {gl2: true, bpp: 16},

1✔

399

1✔

400

  // When using a WebGL 2 context and the EXT_color_buffer_float WebGL2 extension

1✔

401

  [GL.R16F]: {ext: EXT_FLOAT_WEBGL2, bpp: 2},

1✔

402

  [GL.RG16F]: {ext: EXT_FLOAT_WEBGL2, bpp: 4},

1✔

403

  [GL.RGBA16F]: {ext: EXT_FLOAT_WEBGL2, bpp: 8},

1✔

404

  [GL.R32F]: {ext: EXT_FLOAT_WEBGL2, bpp: 4},

1✔

405

  [GL.RG32F]: {ext: EXT_FLOAT_WEBGL2, bpp: 8},

1✔

406

  // TODO - can't get WEBGL_color_buffer_float to work on renderbuffers

1✔

407

  [GL.RGBA32F]: {ext: EXT_FLOAT_WEBGL2, bpp: 16},

1✔

408

  // [GL.RGBA32F]: {ext: EXT_FLOAT_WEBGL2},

1✔

409

  [GL.R11F_G11F_B10F]: {ext: EXT_FLOAT_WEBGL2, bpp: 4}

1✔

410

};

1✔

411

*/

1✔

412

1✔

413

/** @deprecated should be removed */

1✔

414

const DATA_FORMAT_CHANNELS = {

1✔

415

  [GL.RED]: 1,

1✔

416

  [GL.RED_INTEGER]: 1,

1✔

417

  [GL.RG]: 2,

1✔

418

  [GL.RG_INTEGER]: 2,

1✔

419

  [GL.RGB]: 3,

1✔

420

  [GL.RGB_INTEGER]: 3,

1✔

421

  [GL.RGBA]: 4,

1✔

422

  [GL.RGBA_INTEGER]: 4,

1✔

423

  [GL.DEPTH_COMPONENT]: 1,

1✔

424

  [GL.DEPTH_STENCIL]: 1,

1✔

425

  [GL.ALPHA]: 1,

1✔

426

  [GL.LUMINANCE]: 1,

1✔

427

  [GL.LUMINANCE_ALPHA]: 2

1✔

428

};

1✔

429

1✔

430

/** @deprecated should be removed */

1✔

431

const TYPE_SIZES = {

1✔

432

  [GL.FLOAT]: 4,

1✔

433

  [GL.UNSIGNED_INT]: 4,

1✔

434

  [GL.INT]: 4,

1✔

435

  [GL.UNSIGNED_SHORT]: 2,

1✔

436

  [GL.SHORT]: 2,

1✔

437

  [GL.HALF_FLOAT]: 2,

1✔

438

  [GL.BYTE]: 1,

1✔

439

  [GL.UNSIGNED_BYTE]: 1

1✔

440

};

1✔

441

1✔

442

// FUNCTIONS

1✔

443

1✔

444

/** Checks if a texture format is supported */

1✔

445

export function isTextureFormatSupported(

1✔

446

  gl: WebGL2RenderingContext,

123✔

447

  formatOrGL: TextureFormat | GL,

123✔

448

  extensions: GLExtensions

123✔

449

): boolean {

123✔

450

  const format = convertGLToTextureFormat(formatOrGL);

123✔

451

  const info = TEXTURE_FORMATS[format];

123✔

455

  // Check that we have a GL constant

123✔

456

  if (info.gl === undefined) {

123✔

457

    return false;

2✔

458

2✔

459

  // Check extensions

121✔

460

  const extension = info.x || info.gl2ext;

123✔

461

  if (extension) {

123✔

462

    return Boolean(getWebGLExtension(gl, extension, extensions));

25✔

463

25✔

464

  return true;

96✔

465

96✔

466

1✔

467

export function isRenderbufferFormatSupported(

1✔

468

  gl: WebGL2RenderingContext,

122✔

469

  format: TextureFormat,

122✔

470

  extensions: GLExtensions

122✔

471

): boolean {

122✔

472

  // Note: Order is important since the function call initializes extensions.

122✔

473

  return isTextureFormatSupported(gl, format, extensions) && TEXTURE_FORMATS[format]?.renderbuffer;

122✔

474

122✔

475

1✔

476

/**

1✔

477

 * Map WebGL texture formats (GL constants) to WebGPU-style TextureFormat strings

1✔

478

*/

1✔

479

export function convertGLToTextureFormat(format: GL | TextureFormat): TextureFormat {

1✔

480

  if (typeof format === 'string') {

372✔

481

    return format;

301✔

482

301✔

483

  const entry = Object.entries(TEXTURE_FORMATS).find(([, entry]) => entry.gl === format);

71✔

487

  return entry[0] as TextureFormat;

71✔

488

71✔

489

1✔

490

/**

1✔

491

 * Map WebGPU style texture format strings to GL constants

1✔

492

*/

1✔

493

export function convertTextureFormatToGL(format: TextureFormat): GL | undefined {

1✔

494

  const formatInfo = TEXTURE_FORMATS[format];

231✔

495

  const webglFormat = formatInfo?.gl;

231✔

499

  return webglFormat;

231✔

500

231✔

501

1✔

502

/** Checks if a texture format is supported */

1✔

503

export function getTextureFormatSupport(

1✔

544

1✔

545

/** Checks whether linear filtering (interpolated sampling) is available for floating point textures */

1✔

546

export function isTextureFormatFilterable(

1✔

571

1✔

572

export function isTextureFormatRenderable(

1✔

587

1✔

588

export function getWebGLTextureParameters(formatOrGL: TextureFormat | GL) {

1✔

589

  const format = convertGLToTextureFormat(formatOrGL);

163✔

590

  const webglFormat = convertTextureFormatToGL(format);

163✔

591

  const decoded = decodeTextureFormat(format);

163✔

592

  return {

163✔

593

    format: webglFormat,

163✔

594

    dataFormat: getWebGLPixelDataFormat(

163✔

595

      decoded.format,

163✔

596

      decoded.integer,

163✔

597

      decoded.normalized,

163✔

598

      webglFormat

163✔

599

),

163✔

600

    // depth formats don't have a type

163✔

601

    type: decoded.dataType ? getGLFromVertexType(decoded.dataType) : GL.UNSIGNED_BYTE,

163✔

602

    // @ts-expect-error

163✔

603

    compressed: decoded.compressed

163✔

604

};

163✔

605

163✔

606

1✔

607

export function getDepthStencilAttachmentWebGL(

1✔

616

1✔

617

/** TODO - VERY roundabout legacy way of calculating bytes per pixel */

1✔

618

export function getTextureFormatBytesPerPixel(formatOrGL: TextureFormat | GL): number {

1✔

619

  // TODO remove webgl1 support

86✔

620

  const format = convertGLToTextureFormat(formatOrGL);

86✔

621

  const params = getWebGLTextureParameters(format);

86✔

622

  // NOTE(Tarek): Default to RGBA bytes

86✔

625

  return channels * channelSize;

86✔

626

86✔

627

1✔

628

// DATA TYPE HELPERS

1✔

629

1✔

630

function getWebGLPixelDataFormat(

163✔

631

  dataFormat: string,

163✔

632

  integer: boolean,

163✔

633

  normalized: boolean,

163✔

634

  format: GL

163✔

635

): GL {

163✔

636

  // WebGL1 formats use same internalFormat

163✔

637

  if (format === GL.RGBA || format === GL.RGB) {

163✔

638

    return format;

12✔

639

12✔

640

  // prettier-ignore

151✔

641

  switch (dataFormat) {

151✔

642

    case 'r': return integer && !normalized ? GL.RED_INTEGER : GL.RED;

163✔

643

    case 'rg': return integer && !normalized ? GL.RG_INTEGER : GL.RG;

163✔

645

    case 'rgba': return integer && !normalized ? GL.RGBA_INTEGER : GL.RGBA;

163✔

646

    default: return GL.RGBA;

163✔

647

163✔

648

163✔

visgl / luma.gl / 8051293999

Source File
Press 'n' to go to next uncovered line, 'b' for previous

visgl / luma.gl / 8051293999

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous