stop exporting private functions

greggman · Jun 13, 2022 · e3a8d0e · e3a8d0e
1 parent 9a355d5
commit e3a8d0e
Show file tree

Hide file tree

Showing 24 changed files with 55 additions and 1,387 deletions.
diff --git a/dist/4.x/twgl-full.d.ts b/dist/4.x/twgl-full.d.ts
@@ -7,7 +7,6 @@ export type Defaults = {
 };
 export function setDefaults(newDefaults: Defaults): void;
 export function addExtensionsToContext(gl: WebGLRenderingContext): void;
-export function getWebGLContext(canvas: HTMLCanvasElement, opt_attribs?: WebGLContextAttributes): WebGLRenderingContext;
 export function createContext(canvas: HTMLCanvasElement): WebGLRenderingContext;
 export function getContext(canvas: HTMLCanvasElement, opt_attribs?: WebGLContextAttributes): WebGLRenderingContext;
 export function resizeCanvasToDisplaySize(canvas: HTMLCanvasElement, multiplier?: number): boolean;
@@ -256,9 +255,7 @@ export function resizeFramebufferInfo(gl: WebGLRenderingContext, framebufferInfo
 export function bindFramebufferInfo(gl: WebGLRenderingContext, framebufferInfo?: FramebufferInfo | null, target?: number): void;
 
 
-export function getBindPointForSamplerType(): void;
 export type ProgramCallback = (err?: string, result?: WebGLProgram | ProgramInfo) => void;
-export function prepShaderSource(shaderSource: string): any;
 export function createProgram(gl: WebGLRenderingContext, shaders: WebGLShader[] | string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): WebGLProgram;
 export function createProgramAsync(gl: WebGLRenderingContext, shaders: WebGLShader[] | string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): Promise<WebGLProgram>;
 export function createProgramInfoAsync(gl: WebGLRenderingContext, shaderSources: string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): Promise<ProgramInfo>;
@@ -288,11 +285,6 @@ export function setUniformsAndBindTextures(setters: ProgramInfo | {
 export function createAttributeSetters(gl: WebGLRenderingContext, program: WebGLProgram): {
     [key: string]: (...params: any[]) => any;
 };
-export function setAttributes(setters: {
-    [key: string]: (...params: any[]) => any;
-}, buffers: {
-    [key: string]: AttribInfo;
-}): void;
 export function setBuffersAndAttributes(gl: WebGLRenderingContext, setters: ProgramInfo | {
     [key: string]: (...params: any[]) => any;
 }, buffers: BufferInfo | VertexArrayInfo): void;
@@ -314,10 +306,7 @@ export function setTextureParameters(gl: WebGLRenderingContext, tex: WebGLTextur
 export function setSamplerParameters(gl: WebGLRenderingContext, sampler: WebGLSampler, options: TextureOptions): void;
 export function setTextureFilteringForSize(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions, width?: number, height?: number, internalFormat?: number): void;
 export function setTextureFromElement(gl: WebGLRenderingContext, tex: WebGLTexture, element: HTMLElement, options?: TextureOptions): void;
-export function setTextureTo1PixelColor(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions): void;
 export function loadTextureFromUrl(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions, callback?: TextureReadyCallback): HTMLImageElement;
-export function loadCubemapFromUrls(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions, callback?: CubemapReadyCallback): void;
-export function loadSlicesFromUrls(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions, callback?: ThreeDReadyCallback): void;
 export function setTextureFromArray(gl: WebGLRenderingContext, tex: WebGLTexture, src: number[] | ArrayBufferView, options?: TextureOptions): void;
 export function setEmptyTexture(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions): void;
 export function createTexture(gl: WebGLRenderingContext, options?: TextureOptions, callback?: TextureReadyCallback): WebGLTexture;

diff --git a/dist/4.x/twgl-full.js b/dist/4.x/twgl-full.js
diff --git a/dist/4.x/twgl-full.js.map b/dist/4.x/twgl-full.js.map
diff --git a/dist/4.x/twgl-full.module.js b/dist/4.x/twgl-full.module.js
@@ -6088,6 +6088,7 @@ function loadAndUseImage(obj, crossOrigin, callback) {
  * @param {module:twgl.TextureOptions} [options] A TextureOptions object with whatever parameters you want set.
  *   This is often the same options you passed in when you created the texture.
  * @memberOf module:twgl/textures
+ * @private
  */
 function setTextureTo1PixelColor(gl, tex, options) {
   options = options || defaults$1.textureOptions;
@@ -6197,6 +6198,7 @@ function loadTextureFromUrl(gl, tex, options, callback) {
  * @param {module:twgl.CubemapReadyCallback} [callback] A function to be called when all the images have finished loading. err will
  *    be non null if there was an error.
  * @memberOf module:twgl/textures
+ * @private
  */
 function loadCubemapFromUrls(gl, tex, options, callback) {
   callback = callback || noop;
@@ -6280,6 +6282,7 @@ function loadCubemapFromUrls(gl, tex, options, callback) {
  * @param {module:twgl.ThreeDReadyCallback} [callback] A function to be called when all the images have finished loading. err will
  *    be non null if there was an error.
  * @memberOf module:twgl/textures
+ * @private
  */
 function loadSlicesFromUrls(gl, tex, options, callback) {
   callback = callback || noop;
@@ -6858,6 +6861,7 @@ const typeMap = {};
 
 /**
  * Returns the corresponding bind point for a given sampler type
+ * @private
  */
 function getBindPointForSamplerType(gl, type) {
   return typeMap[type].bindPoint;
@@ -7276,6 +7280,7 @@ const spaceRE = /^[ \t]*\n/;
  *
  * @param {string} shaderSource The source of the shader
  * @returns {{shaderSource: string, lineOffset: number}}
+ * @private
  */
 function prepShaderSource(shaderSource) {
   let lineOffset = 0;
@@ -8649,6 +8654,7 @@ function createAttributeSetters(gl, program) {
  * @param {Object.<string, module:twgl.AttribInfo>} buffers AttribInfos mapped by attribute name.
  * @memberOf module:twgl/programs
  * @deprecated use {@link module:twgl.setBuffersAndAttributes}
+ * @private
  */
 function setAttributes(setters, buffers) {
   for (const name in buffers) {
@@ -9776,6 +9782,8 @@ function create3DContext(canvas, opt_attribs) {
  * @param {WebGLContextAttributes} [opt_attribs] optional webgl context creation attributes
  * @return {WebGLRenderingContext} The created context.
  * @memberOf module:twgl
+ * @deprecated
+ * @private
  */
 function getWebGLContext(canvas, opt_attribs) {
   const gl = create3DContext(canvas, opt_attribs);

diff --git a/dist/4.x/twgl.d.ts b/dist/4.x/twgl.d.ts
@@ -7,7 +7,6 @@ export type Defaults = {
 };
 export function setDefaults(newDefaults: Defaults): void;
 export function addExtensionsToContext(gl: WebGLRenderingContext): void;
-export function getWebGLContext(canvas: HTMLCanvasElement, opt_attribs?: WebGLContextAttributes): WebGLRenderingContext;
 export function createContext(canvas: HTMLCanvasElement): WebGLRenderingContext;
 export function getContext(canvas: HTMLCanvasElement, opt_attribs?: WebGLContextAttributes): WebGLRenderingContext;
 export function resizeCanvasToDisplaySize(canvas: HTMLCanvasElement, multiplier?: number): boolean;
@@ -256,9 +255,7 @@ export function resizeFramebufferInfo(gl: WebGLRenderingContext, framebufferInfo
 export function bindFramebufferInfo(gl: WebGLRenderingContext, framebufferInfo?: FramebufferInfo | null, target?: number): void;
 
 
-export function getBindPointForSamplerType(): void;
 export type ProgramCallback = (err?: string, result?: WebGLProgram | ProgramInfo) => void;
-export function prepShaderSource(shaderSource: string): any;
 export function createProgram(gl: WebGLRenderingContext, shaders: WebGLShader[] | string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): WebGLProgram;
 export function createProgramAsync(gl: WebGLRenderingContext, shaders: WebGLShader[] | string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): Promise<WebGLProgram>;
 export function createProgramInfoAsync(gl: WebGLRenderingContext, shaderSources: string[], opt_attribs?: ProgramOptions | string[] | ErrorCallback, opt_errorCallback?: ErrorCallback): Promise<ProgramInfo>;
@@ -288,11 +285,6 @@ export function setUniformsAndBindTextures(setters: ProgramInfo | {
 export function createAttributeSetters(gl: WebGLRenderingContext, program: WebGLProgram): {
     [key: string]: (...params: any[]) => any;
 };
-export function setAttributes(setters: {
-    [key: string]: (...params: any[]) => any;
-}, buffers: {
-    [key: string]: AttribInfo;
-}): void;
 export function setBuffersAndAttributes(gl: WebGLRenderingContext, setters: ProgramInfo | {
     [key: string]: (...params: any[]) => any;
 }, buffers: BufferInfo | VertexArrayInfo): void;
@@ -314,10 +306,7 @@ export function setTextureParameters(gl: WebGLRenderingContext, tex: WebGLTextur
 export function setSamplerParameters(gl: WebGLRenderingContext, sampler: WebGLSampler, options: TextureOptions): void;
 export function setTextureFilteringForSize(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions, width?: number, height?: number, internalFormat?: number): void;
 export function setTextureFromElement(gl: WebGLRenderingContext, tex: WebGLTexture, element: HTMLElement, options?: TextureOptions): void;
-export function setTextureTo1PixelColor(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions): void;
 export function loadTextureFromUrl(gl: WebGLRenderingContext, tex: WebGLTexture, options?: TextureOptions, callback?: TextureReadyCallback): HTMLImageElement;
-export function loadCubemapFromUrls(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions, callback?: CubemapReadyCallback): void;
-export function loadSlicesFromUrls(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions, callback?: ThreeDReadyCallback): void;
 export function setTextureFromArray(gl: WebGLRenderingContext, tex: WebGLTexture, src: number[] | ArrayBufferView, options?: TextureOptions): void;
 export function setEmptyTexture(gl: WebGLRenderingContext, tex: WebGLTexture, options: TextureOptions): void;
 export function createTexture(gl: WebGLRenderingContext, options?: TextureOptions, callback?: TextureReadyCallback): WebGLTexture;

diff --git a/dist/4.x/twgl.js b/dist/4.x/twgl.js
diff --git a/dist/4.x/twgl.js.map b/dist/4.x/twgl.js.map
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-twgl.html b/docs/module-twgl.html
diff --git a/docs/module-twgl_attributes.html b/docs/module-twgl_attributes.html
diff --git a/docs/module-twgl_draw.html b/docs/module-twgl_draw.html
diff --git a/docs/module-twgl_framebuffers.html b/docs/module-twgl_framebuffers.html
diff --git a/docs/module-twgl_m4.html b/docs/module-twgl_m4.html
diff --git a/docs/module-twgl_primitives.html b/docs/module-twgl_primitives.html
diff --git a/docs/module-twgl_programs.html b/docs/module-twgl_programs.html
diff --git a/docs/module-twgl_textures.html b/docs/module-twgl_textures.html
diff --git a/docs/module-twgl_typedArray.html b/docs/module-twgl_typedArray.html
diff --git a/docs/module-twgl_v3.html b/docs/module-twgl_v3.html
diff --git a/docs/module-twgl_vertexArrays.html b/docs/module-twgl_vertexArrays.html
diff --git a/npm/base/dist/4.x/twgl.js b/npm/base/dist/4.x/twgl.js
diff --git a/npm/base/dist/4.x/twgl.js.map b/npm/base/dist/4.x/twgl.js.map
diff --git a/src/programs.js b/src/programs.js
@@ -121,6 +121,7 @@ const typeMap = {};
 
 /**
  * Returns the corresponding bind point for a given sampler type
+ * @private
  */
 function getBindPointForSamplerType(gl, type) {
   return typeMap[type].bindPoint;
@@ -542,6 +543,7 @@ const spaceRE = /^[ \t]*\n/;
  *
  * @param {string} shaderSource The source of the shader
  * @returns {{shaderSource: string, lineOffset: number}}
+ * @private
  */
 function prepShaderSource(shaderSource) {
   let lineOffset = 0;
@@ -1915,6 +1917,7 @@ function createAttributeSetters(gl, program) {
  * @param {Object.<string, module:twgl.AttribInfo>} buffers AttribInfos mapped by attribute name.
  * @memberOf module:twgl/programs
  * @deprecated use {@link module:twgl.setBuffersAndAttributes}
+ * @private
  */
 function setAttributes(setters, buffers) {
   for (const name in buffers) {

diff --git a/src/textures.js b/src/textures.js
@@ -1157,6 +1157,7 @@ function loadAndUseImage(obj, crossOrigin, callback) {
  * @param {module:twgl.TextureOptions} [options] A TextureOptions object with whatever parameters you want set.
  *   This is often the same options you passed in when you created the texture.
  * @memberOf module:twgl/textures
+ * @private
  */
 function setTextureTo1PixelColor(gl, tex, options) {
   options = options || defaults.textureOptions;
@@ -1266,6 +1267,7 @@ function loadTextureFromUrl(gl, tex, options, callback) {
  * @param {module:twgl.CubemapReadyCallback} [callback] A function to be called when all the images have finished loading. err will
  *    be non null if there was an error.
  * @memberOf module:twgl/textures
+ * @private
  */
 function loadCubemapFromUrls(gl, tex, options, callback) {
   callback = callback || noop;
@@ -1349,6 +1351,7 @@ function loadCubemapFromUrls(gl, tex, options, callback) {
  * @param {module:twgl.ThreeDReadyCallback} [callback] A function to be called when all the images have finished loading. err will
  *    be non null if there was an error.
  * @memberOf module:twgl/textures
+ * @private
  */
 function loadSlicesFromUrls(gl, tex, options, callback) {
   callback = callback || noop;

diff --git a/src/twgl.js b/src/twgl.js
@@ -310,6 +310,8 @@ function create3DContext(canvas, opt_attribs) {
  * @param {WebGLContextAttributes} [opt_attribs] optional webgl context creation attributes
  * @return {WebGLRenderingContext} The created context.
  * @memberOf module:twgl
+ * @deprecated
+ * @private
  */
 function getWebGLContext(canvas, opt_attribs) {
   const gl = create3DContext(canvas, opt_attribs);