From da2ae108df7ee9cb95205ec3ca5208bd2fd0298e Mon Sep 17 00:00:00 2001 From: schmelczerandras Date: Fri, 16 Oct 2020 23:27:58 +0200 Subject: [PATCH] Generate documentation --- docs/classes/circlebase.html | 18 +++--- docs/classes/circlelight.html | 38 ++++++------- docs/classes/drawable.html | 12 ++-- docs/classes/dropletbase.html | 22 +++---- docs/classes/flashlight.html | 46 +++++++-------- docs/classes/invertedtunnelbase.html | 22 +++---- docs/classes/metacirclebase.html | 18 +++--- docs/classes/polygonbase.html | 16 +++--- docs/classes/rotatedrectanglebase.html | 20 +++---- docs/enums/filteringoptions.html | 10 ++-- docs/enums/wrapoptions.html | 12 ++-- docs/globals.html | 76 ++++++++++++------------- docs/index.html | 8 +-- docs/interfaces/drawabledescriptor.html | 18 +++--- docs/interfaces/noisypolygonbase.html | 18 +++--- docs/interfaces/renderer.html | 26 ++++----- docs/interfaces/runtimesettings.html | 20 +++---- docs/interfaces/startupsettings.html | 16 +++--- docs/interfaces/textureoptions.html | 14 ++--- package.json | 2 +- 20 files changed, 216 insertions(+), 216 deletions(-) diff --git a/docs/classes/circlebase.html b/docs/classes/circlebase.html index 06609e6..95c775a 100644 --- a/docs/classes/circlebase.html +++ b/docs/classes/circlebase.html @@ -3,8 +3,8 @@ - CircleBase | SDF-2D - v0.5.2 - + CircleBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -120,7 +120,7 @@

  • Parameters

    @@ -145,7 +145,7 @@
    center: vec2
    @@ -155,7 +155,7 @@
    radius: number
    @@ -167,7 +167,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -186,7 +186,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -214,7 +214,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/classes/circlelight.html b/docs/classes/circlelight.html index 89b5e4c..da9e3b9 100644 --- a/docs/classes/circlelight.html +++ b/docs/classes/circlelight.html @@ -3,8 +3,8 @@ - CircleLight | SDF-2D - v0.5.2 - + CircleLight | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -129,7 +129,7 @@

    Parameters

    @@ -158,7 +158,7 @@ @@ -169,7 +169,7 @@ @@ -180,7 +180,7 @@ @@ -191,7 +191,7 @@ @@ -210,7 +210,7 @@

    Inherited from LightDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -238,7 +238,7 @@

    Inherited from Flashlight.minDistance

    Overrides Drawable.minDistance

    Parameters

    @@ -262,7 +262,7 @@

    Parameters

    @@ -285,7 +285,7 @@
    @@ -294,7 +294,7 @@
    empty: CircleLight = new CircleLight(vec2.create(), vec3.create(), 0)
    @@ -304,7 +304,7 @@
    shaderCombinationSteps: number[] = [0, 1, 2, 4, 8, 16]
    @@ -314,7 +314,7 @@
    uniformCountMacroName: string = "CIRCLE_LIGHT_COUNT"
    @@ -324,7 +324,7 @@
    propertyUniformMapping: object
    @@ -333,7 +333,7 @@
    center: string = "circleLightCenters"
    @@ -343,7 +343,7 @@
    color: string = "circleLightColors"
    @@ -353,7 +353,7 @@
    intensity: string = "circleLightIntensities"
    diff --git a/docs/classes/drawable.html b/docs/classes/drawable.html index 9715817..f7b5953 100644 --- a/docs/classes/drawable.html +++ b/docs/classes/drawable.html @@ -3,8 +3,8 @@ - Drawable | SDF-2D - v0.5.2 - + Drawable | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -110,7 +110,7 @@
    descriptor: DrawableDescriptor
    @@ -132,7 +132,7 @@
  • @@ -171,7 +171,7 @@
  • diff --git a/docs/classes/dropletbase.html b/docs/classes/dropletbase.html index 7da34ba..3f457a1 100644 --- a/docs/classes/dropletbase.html +++ b/docs/classes/dropletbase.html @@ -3,8 +3,8 @@ - DropletBase | SDF-2D - v0.5.2 - + DropletBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -122,7 +122,7 @@

  • Parameters

    @@ -153,7 +153,7 @@
    from: vec2
    @@ -163,7 +163,7 @@
    fromRadius: number
    @@ -173,7 +173,7 @@
    to: vec2
    @@ -183,7 +183,7 @@
    toRadius: number
    @@ -195,7 +195,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -214,7 +214,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -242,7 +242,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/classes/flashlight.html b/docs/classes/flashlight.html index f00f107..065ac71 100644 --- a/docs/classes/flashlight.html +++ b/docs/classes/flashlight.html @@ -3,8 +3,8 @@ - Flashlight | SDF-2D - v0.5.2 - + Flashlight | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -131,7 +131,7 @@

    Parameters

    @@ -166,7 +166,7 @@ @@ -177,7 +177,7 @@ @@ -187,7 +187,7 @@
    direction: vec2
    @@ -198,7 +198,7 @@ @@ -209,7 +209,7 @@ @@ -219,7 +219,7 @@
    startCutoff: number
    @@ -237,7 +237,7 @@

    Parameters

    @@ -265,7 +265,7 @@

    Inherited from Flashlight.minDistance

    Overrides Drawable.minDistance

    Parameters

    @@ -289,7 +289,7 @@

    Parameters

    @@ -312,7 +312,7 @@
    @@ -321,7 +321,7 @@
    empty: Flashlight = new Flashlight(vec2.create(), vec3.create(), 0, vec2.create())
    @@ -331,7 +331,7 @@
    shaderCombinationSteps: number[] = [0, 1, 2, 4]
    @@ -341,7 +341,7 @@
    uniformCountMacroName: string = "FLASHLIGHT_COUNT"
    @@ -351,7 +351,7 @@
    propertyUniformMapping: object
    @@ -360,7 +360,7 @@
    center: string = "flashlightCenters"
    @@ -370,7 +370,7 @@
    color: string = "flashlightColors"
    @@ -380,7 +380,7 @@
    direction: string = "flashlightDirections"
    @@ -390,7 +390,7 @@
    intensity: string = "flashlightIntensities"
    @@ -400,7 +400,7 @@
    startCutoff: string = "flashlightStartCutoffs"
    diff --git a/docs/classes/invertedtunnelbase.html b/docs/classes/invertedtunnelbase.html index 8b9621c..df239b4 100644 --- a/docs/classes/invertedtunnelbase.html +++ b/docs/classes/invertedtunnelbase.html @@ -3,8 +3,8 @@ - InvertedTunnelBase | SDF-2D - v0.5.2 - + InvertedTunnelBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -122,7 +122,7 @@

  • Parameters

    @@ -153,7 +153,7 @@
    from: vec2
    @@ -163,7 +163,7 @@
    fromRadius: number
    @@ -173,7 +173,7 @@
    to: vec2
    @@ -183,7 +183,7 @@
    toRadius: number
    @@ -195,7 +195,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -214,7 +214,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -242,7 +242,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/classes/metacirclebase.html b/docs/classes/metacirclebase.html index 8bae64b..76ba8bc 100644 --- a/docs/classes/metacirclebase.html +++ b/docs/classes/metacirclebase.html @@ -3,8 +3,8 @@ - MetaCircleBase | SDF-2D - v0.5.2 - + MetaCircleBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -120,7 +120,7 @@

  • Parameters

    @@ -145,7 +145,7 @@
    center: vec2
    @@ -155,7 +155,7 @@
    radius: number
    @@ -167,7 +167,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -186,7 +186,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -214,7 +214,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/classes/polygonbase.html b/docs/classes/polygonbase.html index 1e75cfc..94bfce4 100644 --- a/docs/classes/polygonbase.html +++ b/docs/classes/polygonbase.html @@ -3,8 +3,8 @@ - PolygonBase | SDF-2D - v0.5.2 - + PolygonBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -124,7 +124,7 @@

  • Parameters

    @@ -146,7 +146,7 @@
    vertices: Array<vec2>
    @@ -158,7 +158,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -177,7 +177,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -205,7 +205,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/classes/rotatedrectanglebase.html b/docs/classes/rotatedrectanglebase.html index a70effc..697ab04 100644 --- a/docs/classes/rotatedrectanglebase.html +++ b/docs/classes/rotatedrectanglebase.html @@ -3,8 +3,8 @@ - RotatedRectangleBase | SDF-2D - v0.5.2 - + RotatedRectangleBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -121,7 +121,7 @@

  • Parameters

    @@ -149,7 +149,7 @@
    center: vec2
    @@ -159,7 +159,7 @@
    rotation: number
    @@ -169,7 +169,7 @@
    size: vec2
    @@ -181,7 +181,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -200,7 +200,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -228,7 +228,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/enums/filteringoptions.html b/docs/enums/filteringoptions.html index d7f1e75..aa2ff46 100644 --- a/docs/enums/filteringoptions.html +++ b/docs/enums/filteringoptions.html @@ -3,8 +3,8 @@ - FilteringOptions | SDF-2D - v0.5.2 - + FilteringOptions | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -85,7 +85,7 @@
    LINEAR: = "LINEAR"
    @@ -95,7 +95,7 @@
    NEAREST: = "NEAREST"
    diff --git a/docs/enums/wrapoptions.html b/docs/enums/wrapoptions.html index 88a12cf..bdb3dd6 100644 --- a/docs/enums/wrapoptions.html +++ b/docs/enums/wrapoptions.html @@ -3,8 +3,8 @@ - WrapOptions | SDF-2D - v0.5.2 - + WrapOptions | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -86,7 +86,7 @@
    CLAMP_TO_EDGE: = "CLAMP_TO_EDGE"
    @@ -96,7 +96,7 @@
    MIRRORED_REPEAT: = "MIRRORED_REPEAT"
    @@ -111,7 +111,7 @@
    REPEAT: = "REPEAT"
    diff --git a/docs/globals.html b/docs/globals.html index 77fd154..4cc08b1 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -3,8 +3,8 @@ - SDF-2D - v0.5.2 - + SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -53,7 +53,7 @@ Globals -

    SDF-2D - v0.5.2

    +

    SDF-2D - v0.5.3

    @@ -149,7 +149,7 @@
    TextureWithOptions: { overrides: Partial<TextureOptions>; source: TexImageSource }
    @@ -177,7 +177,7 @@
  • @@ -208,7 +208,7 @@
  • @@ -258,7 +258,7 @@
  • @@ -307,7 +307,7 @@
  • @@ -356,7 +356,7 @@
  • @@ -413,7 +413,7 @@
  • @@ -473,7 +473,7 @@
  • @@ -498,7 +498,7 @@
  • @@ -523,7 +523,7 @@
  • @@ -551,7 +551,7 @@
  • @@ -570,13 +570,13 @@

    Const NoisyPolygonFactory

      -
    • NoisyPolygonFactory(vertexCount: number, colorIndex: number): typeof PolygonBase & NoisyPolygonBase
      • +
    • NoisyPolygonFactory(vertexCount: number, color: vec3 | vec4 | number): typeof PolygonBase & NoisyPolygonBase

    Returns typeof PolygonBase & NoisyPolygonBase

    @@ -598,13 +598,13 @@

    Const PolygonFactory

      -
    • PolygonFactory(vertexCount: number, colorIndex: number): typeof PolygonBase
      • +
    • PolygonFactory(vertexCount: number, color: vec3 | vec4 | number): typeof PolygonBase

    Returns typeof PolygonBase

    @@ -632,7 +632,7 @@
  • @@ -660,7 +660,7 @@
  • @@ -717,7 +717,7 @@
  • @@ -775,7 +775,7 @@
    defaultRuntimeSettings: object
    @@ -789,7 +789,7 @@
    ambientLight: vec3 = vec3.fromValues(0.25, 0.15, 0.25)
    @@ -799,7 +799,7 @@
    colorPalette: never[] = []
    @@ -809,7 +809,7 @@
    enableHighDpiRendering: false = false
    @@ -819,7 +819,7 @@
    isWorldInverted: false = false
    @@ -829,7 +829,7 @@
    lightCutoffDistance: number = 400
    @@ -839,7 +839,7 @@
    textures: {}
    @@ -854,7 +854,7 @@
    tileMultiplier: number = 8
    @@ -865,7 +865,7 @@
    defaultStartupSettings: object
    @@ -879,7 +879,7 @@
    backgroundColor: vec4 = vec4.fromValues(1, 1, 1, 1)
    @@ -889,7 +889,7 @@
    enableStopwatch: false = false
    @@ -899,7 +899,7 @@
    ignoreWebGL2: false = false
    @@ -909,7 +909,7 @@
    paletteSize: number = 256
    @@ -919,7 +919,7 @@
    shadowTraceCount: number = 16
    diff --git a/docs/index.html b/docs/index.html index 9d28551..c560b69 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,8 +3,8 @@ - SDF-2D - v0.5.2 - + SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -53,7 +53,7 @@ Globals -

    SDF-2D - v0.5.2

    +

    SDF-2D - v0.5.3

    diff --git a/docs/interfaces/drawabledescriptor.html b/docs/interfaces/drawabledescriptor.html index 0e1b8ef..be1cff1 100644 --- a/docs/interfaces/drawabledescriptor.html +++ b/docs/interfaces/drawabledescriptor.html @@ -3,8 +3,8 @@ - DrawableDescriptor | SDF-2D - v0.5.2 - + DrawableDescriptor | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -108,7 +108,7 @@
    empty: Drawable
    @@ -124,7 +124,7 @@
    objectCountScaler: undefined | number
    @@ -141,7 +141,7 @@
    propertyUniformMapping: {}
    @@ -165,7 +165,7 @@
    sdf: undefined | { distanceFunctionName: string; isInverted?: undefined | false | true; shader: string }
    @@ -180,7 +180,7 @@
    shaderCombinationSteps: Array<number>
    @@ -198,7 +198,7 @@
    uniformCountMacroName: string
    diff --git a/docs/interfaces/noisypolygonbase.html b/docs/interfaces/noisypolygonbase.html index dd60bdc..b184212 100644 --- a/docs/interfaces/noisypolygonbase.html +++ b/docs/interfaces/noisypolygonbase.html @@ -3,8 +3,8 @@ - NoisyPolygonBase | SDF-2D - v0.5.2 - + NoisyPolygonBase | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -117,7 +117,7 @@

    Parameters

    @@ -139,7 +139,7 @@
    randomOffset: number
    @@ -149,7 +149,7 @@
    vertices: Array<vec2>
    @@ -161,7 +161,7 @@

    Inherited from EmptyDrawable.descriptor

    Overrides Drawable.descriptor

    @@ -180,7 +180,7 @@

    Inherited from EmptyDrawable.getObjectToSerialize

    Overrides Drawable.getObjectToSerialize

    Parameters

    @@ -208,7 +208,7 @@

    Inherited from EmptyDrawable.minDistance

    Overrides Drawable.minDistance

    Parameters

    diff --git a/docs/interfaces/renderer.html b/docs/interfaces/renderer.html index 0d96799..502e599 100644 --- a/docs/interfaces/renderer.html +++ b/docs/interfaces/renderer.html @@ -3,8 +3,8 @@ - Renderer | SDF-2D - v0.5.2 - + Renderer | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -114,7 +114,7 @@
    canvasSize: vec2
    @@ -129,7 +129,7 @@
    insights: any
    @@ -148,7 +148,7 @@
    viewAreaSize: vec2
    @@ -171,7 +171,7 @@
  • @@ -209,7 +209,7 @@
  • @@ -243,7 +243,7 @@
  • @@ -267,7 +267,7 @@
  • @@ -301,7 +301,7 @@
  • @@ -325,7 +325,7 @@
  • @@ -355,7 +355,7 @@
  • diff --git a/docs/interfaces/runtimesettings.html b/docs/interfaces/runtimesettings.html index 8da5431..9d4860b 100644 --- a/docs/interfaces/runtimesettings.html +++ b/docs/interfaces/runtimesettings.html @@ -3,8 +3,8 @@ - RuntimeSettings | SDF-2D - v0.5.2 - + RuntimeSettings | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -107,7 +107,7 @@
    ambientLight: vec3
    @@ -122,7 +122,7 @@
    colorPalette: Array<vec3 | vec4>
    @@ -140,7 +140,7 @@
    enableHighDpiRendering: boolean
    @@ -155,7 +155,7 @@
    isWorldInverted: boolean
    @@ -172,7 +172,7 @@
    lightCutoffDistance: number
    @@ -188,7 +188,7 @@
    textures: {}
    @@ -215,7 +215,7 @@
    tileMultiplier: number
    diff --git a/docs/interfaces/startupsettings.html b/docs/interfaces/startupsettings.html index 5c01d14..f452dfe 100644 --- a/docs/interfaces/startupsettings.html +++ b/docs/interfaces/startupsettings.html @@ -3,8 +3,8 @@ - StartupSettings | SDF-2D - v0.5.2 - + StartupSettings | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -105,7 +105,7 @@
    backgroundColor: vec3 | vec4
    @@ -120,7 +120,7 @@
    enableStopwatch: boolean
    @@ -137,7 +137,7 @@
    ignoreWebGL2: boolean
    @@ -154,7 +154,7 @@
    paletteSize: number
    @@ -172,7 +172,7 @@
    shadowTraceCount: number
    diff --git a/docs/interfaces/textureoptions.html b/docs/interfaces/textureoptions.html index 9a520cc..5135ebc 100644 --- a/docs/interfaces/textureoptions.html +++ b/docs/interfaces/textureoptions.html @@ -3,8 +3,8 @@ - TextureOptions | SDF-2D - v0.5.2 - + TextureOptions | SDF-2D - v0.5.3 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - SDF-2D - v0.5.2 + SDF-2D - v0.5.3
    @@ -95,7 +95,7 @@
    maxFilter: FilteringOptions
    @@ -105,7 +105,7 @@
    minFilter: FilteringOptions
    @@ -115,7 +115,7 @@
    wrapS: WrapOptions
    @@ -125,7 +125,7 @@
    wrapT: WrapOptions
    diff --git a/package.json b/package.json index 01e82c0..a6a5124 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sdf-2d", - "version": "0.5.2", + "version": "0.5.3", "description": "Graphics framework for efficiently rendering 2D signed distance fields.", "keywords": [ "webgl",