${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r
+
+
+
+
+ Class CircleBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/circlelight.html b/docs/classes/circlelight.html
new file mode 100644
index 0000000..4d7472e
--- /dev/null
+++ b/docs/classes/circlelight.html
@@ -0,0 +1,444 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + CircleBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- radius +
- descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
radius: number
+
+
Returns CircleBase
+
+ -
+
Properties
+center
+ + +radius
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class CircleLight
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/colorfulcircle.html b/docs/classes/colorfulcircle.html
new file mode 100644
index 0000000..227834a
--- /dev/null
+++ b/docs/classes/colorfulcircle.html
@@ -0,0 +1,421 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected lightness
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+ shader
+
+
+
+
+
+ uniform
+
+
+
+
+
+ property
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ LightDrawable
+
-
+
- + CircleLight + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- color +
- intensity +
- lightness
Ratio
+
Methods
+ +Object literals
+-
+
- descriptor +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
color: vec3
+
+ -
+
intensity: number
+
+
Returns CircleLight
+
+ -
+
Properties
+center
+ + +color
+ + +intensity
+ + +Protected lightnessRatio
+
+
+ Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
setLightnessRatio
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
ratio: number
+
+
Returns void
+
+ -
+
Object literals
+Static Readonly descriptor
+ + +empty
+ + +shaderCombinationSteps
+
+
+ uniformCountMacroName
+
+
+ propertyUniformMapping
+
+
+ center
+ + +color
+ + +intensity
+ + +
+
+
+
+
+ Class ColorfulCircle
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/deltatimecalculator.html b/docs/classes/deltatimecalculator.html
new file mode 100644
index 0000000..8c45e47
--- /dev/null
+++ b/docs/classes/deltatimecalculator.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ color
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+
+
+
+
+ shader
+
+
+
+
+
+ uniform
+
+
+
+
+
+ property
+
+
+
+
+
+
+
+ color
+
+
+
+
+
+
+
+
+
+
+
+ distance
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Drawable
+
-
+
- + ColorfulCircle + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- color
Index
+ - radius +
Methods
+ +Object literals
+-
+
- descriptor +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
radius: number
+
+ -
+
colorIndex: number
+
+
Returns ColorfulCircle
+
+ -
+
Properties
+center
+ + +colorIndex
+
+
+ radius
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
Object literals
+Static descriptor
+ + +empty
+ + +shaderCombinationSteps
+
+
+ uniformCountMacroName
+
+
+ propertyUniformMapping
+
+
+ center
+ + +colorIndex
+
+
+ radius
+ + +sdf
+ + +distanceFunctionName
+
+
+ shader
+ + +
+
+
+
+
+ Class DeltaTimeCalculator
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/drawable.html b/docs/classes/drawable.html
new file mode 100644
index 0000000..03f4991
--- /dev/null
+++ b/docs/classes/drawable.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+ A helper class for calculating the elapsed time between frames.
+Handles the case, where the browser tab is not in focus and requestAnimationFrame
+ does not get called for performance reasons. In this case, the return deltaTime won't be
+ an unreasonably large value.
Hierarchy
+-
+
- + DeltaTimeCalculator + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Methods
+-
+
- destroy +
- get
Next Delta Time
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Returns DeltaTimeCalculator
+
+
Methods
+destroy
+-
+
+
-
+
-
+
+
Returns void
+
+
getNextDeltaTime
+ -
+
+
-
+
-
+
+ ++++
Return the elapsed time in milliseconds since the previous call of this + method by subtracting the previously given
+currentTimeargument from the + currentcurrentTimeargument.Takes visibilitychange events into account.
+Parameters
+-
+
-
+
currentTime: DOMHighResTimeStamp
+++Current time acquired e.g. with
+requestAnimationFrame.
+
Returns DOMHighResTimeStamp
+
+ -
+
+
+
+
+
+ Class Drawable
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/drawables_drawable.Drawable.html b/docs/classes/drawables_drawable.Drawable.html
deleted file mode 100644
index c82caf3..0000000
--- a/docs/classes/drawables_drawable.Drawable.html
+++ /dev/null
@@ -1,19 +0,0 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected Abstract get
+
+
+
+ Abstract min
+
+
+
+
+
+
+
+
+ Base class of every drawable object.
+To create your own drawables, you need to subclass from this.
+++Although lights are also subclasses of Drawable, you cannot create your own light sources.
+
Hierarchy
+-
+
-
+ Drawable
+
-
+
- + ColorfulCircle + +
+
Index
+
+
+
+
+
+
+ Properties
+-
+
- descriptor +
Methods
+ +Properties
+Static Readonly descriptor
+ + +
+
+
+
+ This should be defined in inherited classes.
+Methods
+Protected Abstract getObjectToSerialize
+ -
+
+
-
+
-
+
+ ++++
Return the values that should be given to the shaders through uniform inputs.
+Parameters
+-
+
-
+
transform2d: mat2d
+++position-like properties should be transformed by this matrix + before being returned.
+
+ -
+
transform1d: number
+++scalar properties should be transformed by this number + before being returned.
+
+
Returns any
+
+ -
+
Abstract minDistance
+ -
+
+
-
+
-
+
+ ++++
The lower bound of the distance between the target and the object.
+It can return 0 by default, the only consequence of this, is a reduced performance. + Because this object won't benefit from tile-based rendering.
+Parameters
+-
+
-
+
target: vec2
+++
+
Returns number
+
+ -
+
Class DrawableAbstract
Base class of every drawable object.
-To create your own drawables, you need to subclass from this.
---Although lights are also subclasses of Drawable, you cannot create your own light sources.
-
Hierarchy (View Summary)
- Drawable
Index
Methods
Protected Abstractget
Return the values that should be given to the shaders through uniform inputs.
-Parameters
- transform2d: mat2d
position-like properties should be transformed by this matrix -before being returned.
- - transform1d: number
scalar properties should be transformed by this number -before being returned.
-
Returns any
- transform2d: mat2d
Abstractmin
The lower bound of the distance between the target and the object.
-It can return 0 by default, the only consequence of this, is a reduced performance. -Because this object won't benefit from tile-based rendering.
-Parameters
- target: vec2
Returns number
Class CircleLight
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
- center: vec2
- color: vec3
- intensity: number
Returns CircleLight
Properties
center
center: vec2
color
color: vec3
intensity
intensity: number
Protectedlightness
lightnessRatio: number = 1
Static Readonlydescriptor
This should be defined in inherited classes.
-Methods
Protectedget
Return the values that should be given to the shaders through uniform inputs.
-Parameters
- transform2d: mat2d
position-like properties should be transformed by this matrix -before being returned.
- - transform1d: number
scalar properties should be transformed by this number -before being returned.
-
Returns any
- transform2d: mat2d
min
The lower bound of the distance between the target and the object.
-It can return 0 by default, the only consequence of this, is a reduced performance. -Because this object won't benefit from tile-based rendering.
-Parameters
- target: vec2
Returns number
set
Parameters
- ratio: number
Returns void
Class Flashlight
Index
Constructors
Properties
Methods
Constructors
constructor
- new Flashlight(
center: vec2,
color: vec3,
intensity: number,
direction: vec2,
startCutoff?: number,
): FlashlightParameters
- center: vec2
- color: vec3
- intensity: number
- direction: vec2
- startCutoff: number = 0
Returns Flashlight
Properties
center
center: vec2
color
color: vec3
direction
direction: vec2
intensity
intensity: number
Protectedlightness
lightnessRatio: number = 1
start
startCutoff: number = 0
Static Readonlydescriptor
This should be defined in inherited classes.
-Methods
Protectedget
Parameters
- transform2d: mat2d
- transform1d: number
Returns any
min
The lower bound of the distance between the target and the object.
-It can return 0 by default, the only consequence of this, is a reduced performance. -Because this object won't benefit from tile-based rendering.
-Parameters
- target: vec2
Returns number
set
Parameters
- ratio: number
Returns void
Class ColorfulCircle
Base class of every drawable object.
-To create your own drawables, you need to subclass from this.
---Although lights are also subclasses of Drawable, you cannot create your own light sources.
-
Hierarchy (View Summary)
- Drawable
- ColorfulCircle
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
- center: vec2
- radius: number
- colorIndex: number
Returns ColorfulCircle
Properties
center
center: vec2
color
colorIndex: number
radius
radius: number
Staticdescriptor
This should be defined in inherited classes.
-Methods
Protectedget
Return the values that should be given to the shaders through uniform inputs.
-Parameters
- transform2d: mat2d
position-like properties should be transformed by this matrix -before being returned.
- - transform1d: number
scalar properties should be transformed by this number -before being returned.
-
Returns any
- transform2d: mat2d
min
The lower bound of the distance between the target and the object.
-It can return 0 by default, the only consequence of this, is a reduced performance. -Because this object won't benefit from tile-based rendering.
-Parameters
- target: vec2
Returns number
Class PolygonBase
Index
Constructors
constructor
Parameters
- vertices: vec2[]
Returns PolygonBase
Properties
vertices
vertices: vec2[]
Static Readonlydescriptor
This should be defined in inherited classes.
-Methods
Protectedget
Return the values that should be given to the shaders through uniform inputs.
-Parameters
- transform2d: mat2d
position-like properties should be transformed by this matrix -before being returned.
- - transform1d: number
scalar properties should be transformed by this number -before being returned.
-
Returns any
- transform2d: mat2d
min
The lower bound of the distance between the target and the object.
-It can return 0 by default, the only consequence of this, is a reduced performance. -Because this object won't benefit from tile-based rendering.
-Parameters
- target: vec2
Returns number
+
+
+
+
+ Class DropletBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/flashlight.html b/docs/classes/flashlight.html
new file mode 100644
index 0000000..54b4906
--- /dev/null
+++ b/docs/classes/flashlight.html
@@ -0,0 +1,497 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly from
+
+
+
+
+
+
+
+
+ Readonly to
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + DropletBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- from +
- from
Radius
+ - to +
- to
Radius
+ - descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
from: vec2
+
+ -
+
to: vec2
+
+ -
+
fromRadius: number
+
+ -
+
toRadius: number
+
+
Returns DropletBase
+
+ -
+
Properties
+Readonly from
+ + +Readonly fromRadius
+
+
+ Readonly to
+ + +Readonly toRadius
+
+
+ Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class Flashlight
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/fpsqualityautoscaler.html b/docs/classes/fpsqualityautoscaler.html
new file mode 100644
index 0000000..66c5f87
--- /dev/null
+++ b/docs/classes/fpsqualityautoscaler.html
@@ -0,0 +1,290 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected lightness
+
+
+
+
+
+ start
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+ shader
+
+
+
+
+
+ uniform
+
+
+
+
+
+ property
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ start
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ LightDrawable
+
-
+
- + Flashlight + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- color +
- direction +
- intensity +
- lightness
Ratio
+ - start
Cutoff
+
Methods
+ +Object literals
+-
+
- descriptor +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
color: vec3
+
+ -
+
intensity: number
+
+ -
+
direction: vec2
+
+ -
+
Default value startCutoff: number = 0
+
+
Returns Flashlight
+
+ -
+
Properties
+center
+ + +color
+ + +direction
+ + +intensity
+ + +Protected lightnessRatio
+
+
+ startCutoff
+
+
+ Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
setLightnessRatio
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
ratio: number
+
+
Returns void
+
+ -
+
Object literals
+Static Readonly descriptor
+ + +empty
+ + +shaderCombinationSteps
+
+
+ uniformCountMacroName
+
+
+ propertyUniformMapping
+
+
+ center
+ + +color
+ + +direction
+ + +intensity
+ + +startCutoff
+
+
+
+
+
+
+
+ Class FpsQualityAutoscaler
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html b/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html
deleted file mode 100644
index b5bbccf..0000000
--- a/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ fps
+
+
+
+
+
+ Static fps
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+
+
+ Set the quality of rendering based on FPS values.
+When using this the size of the canvas must be fixed with CSS.
+The addDeltaTime method should be called once every frame.
Usage:
+ const renderer = await compile(...);
+ const autoscaler = new FpsQualityAutoscaler(renderer);
+Hierarchy
+-
+
- + FpsQualityAutoscaler + +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- fps
Hysteresis
+ - fps
Target
+
Accessors
+-
+
- FPS +
Methods
+-
+
- add
Delta Time
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
renderer: Renderer
+
+
Returns FpsQualityAutoscaler
+
+ -
+
Properties
+fpsHysteresis
+
+
+ Static fpsTarget
+
+
+ Accessors
+FPS
+-
+
+
-
+
-
+
+
Returns number
+
+
Methods
+addDeltaTime
+ -
+
+
-
+
-
+
+ ++++
Autoscaling is also done by calling this function
+Parameters
+-
+
-
+
deltaTimeInMilliseconds: DOMHighResTimeStamp
+++
+
Returns void
+
+ -
+
Class FpsQualityAutoscaler
Set the quality of rendering based on FPS values.
-When using this the size of the canvas must be fixed with CSS.
-The addDeltaTime method should be called once every frame.
Usage:
- const renderer = await compile(...);
const autoscaler = new FpsQualityAutoscaler(renderer);
-Index
Constructors
constructor
Parameters
- renderer: Renderer
Returns FpsQualityAutoscaler
Class DeltaTimeCalculator
A helper class for calculating the elapsed time between frames.
-Handles the case, where the browser tab is not in focus and requestAnimationFrame
-does not get called for performance reasons. In this case, the return deltaTime won't be
-an unreasonably large value.
Index
Constructors
Methods
Constructors
constructor
Returns DeltaTimeCalculator
Methods
destroy
Returns void
get
Return the elapsed time in milliseconds since the previous call of this -method by subtracting the previously given
-currentTimeargument from the -currentcurrentTimeargument.Takes visibilitychange events into account.
-Parameters
- currentTime: number
Current time acquired e.g. with
-requestAnimationFrame.
Returns number
- currentTime: number
+
+
+
+
+ Class HexagonBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/invertedtunnelbase.html b/docs/classes/invertedtunnelbase.html
new file mode 100644
index 0000000..7226372
--- /dev/null
+++ b/docs/classes/invertedtunnelbase.html
@@ -0,0 +1,337 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + HexagonBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- radius +
- descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
radius: number
+
+
Returns HexagonBase
+
+ -
+
Properties
+center
+ + +radius
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class InvertedTunnelBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/metacirclebase.html b/docs/classes/metacirclebase.html
new file mode 100644
index 0000000..148c870
--- /dev/null
+++ b/docs/classes/metacirclebase.html
@@ -0,0 +1,303 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly from
+
+
+
+
+
+
+
+
+ Readonly to
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + InvertedTunnelBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- from +
- from
Radius
+ - to +
- to
Radius
+ - descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
from: vec2
+
+ -
+
to: vec2
+
+ -
+
fromRadius: number
+
+ -
+
toRadius: number
+
+
Returns InvertedTunnelBase
+
+ -
+
Properties
+Readonly from
+ + +Readonly fromRadius
+
+
+ Readonly to
+ + +Readonly toRadius
+
+
+ Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class MetaCircleBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/polygonbase.html b/docs/classes/polygonbase.html
new file mode 100644
index 0000000..1908c5f
--- /dev/null
+++ b/docs/classes/polygonbase.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + MetaCircleBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- radius +
- descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
radius: number
+
+
Returns MetaCircleBase
+
+ -
+
Properties
+center
+ + +radius
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class PolygonBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/rotatedrectanglebase.html b/docs/classes/rotatedrectanglebase.html
new file mode 100644
index 0000000..240ea62
--- /dev/null
+++ b/docs/classes/rotatedrectanglebase.html
@@ -0,0 +1,320 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
-
+ PolygonBase
+
-
+
- + NoisyPolygonBase + +
+
+ -
+ PolygonBase
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
vertices: Array<vec2>
+
+
Returns PolygonBase
+
+ -
+
Properties
+vertices
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class RotatedRectangleBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/enums/filteringoptions.html b/docs/enums/filteringoptions.html
new file mode 100644
index 0000000..72af880
--- /dev/null
+++ b/docs/enums/filteringoptions.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EmptyDrawable
+
-
+
- + RotatedRectangleBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- center +
- rotation +
- size +
- descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
center: vec2
+
+ -
+
size: vec2
+
+ -
+
rotation: number
+
+
Returns RotatedRectangleBase
+
+ -
+
Properties
+center
+ + +rotation
+ + +size
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Enumeration FilteringOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/enums/graphics_graphics-library_texture_texture-options.FilteringOptions.html b/docs/enums/graphics_graphics-library_texture_texture-options.FilteringOptions.html
deleted file mode 100644
index 8788e1f..0000000
--- a/docs/enums/graphics_graphics-library_texture_texture-options.FilteringOptions.html
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/docs/enums/graphics_graphics-library_texture_texture-options.WrapOptions.html b/docs/enums/graphics_graphics-library_texture_texture-options.WrapOptions.html
deleted file mode 100644
index 78700b0..0000000
--- a/docs/enums/graphics_graphics-library_texture_texture-options.WrapOptions.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
Enumeration WrapOptions
Index
Enumeration Members
+
+
+
+
+ Enumeration WrapOptions
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/assets/favicon.ico b/docs/favicon.ico
similarity index 100%
rename from docs/assets/favicon.ico
rename to docs/favicon.ico
diff --git a/docs/functions/compile.compile.html b/docs/functions/compile.compile.html
deleted file mode 100644
index 544adec..0000000
--- a/docs/functions/compile.compile.html
+++ /dev/null
@@ -1,17 +0,0 @@
-
+
+
+
+
+
+
+
+
+
+ CLAMP_
+
+
+
+
+
+ MIRRORED_
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+-
+
- CLAMP_
TO_ EDGE
+ - MIRRORED_
REPEAT
+ - REPEAT +
Enumeration members
+CLAMP_TO_EDGE
+
+
+ MIRRORED_REPEAT
+
+
+
+
+
+
+ On WebGL it only work with power of 2 texture sizes.
+REPEAT
+ + +
+
+
+
+ On WebGL it only work with power of 2 texture sizes.
+Function compile
- compile(
canvas: HTMLCanvasElement,
descriptors: DrawableDescriptor[],
settingsOverrides?: Partial<StartupSettings>,
): Promise<Renderer>Compiles a new renderer instance. There can multiple renderers on a single page.
--
-Asynchronous behaviour is required for parallel shader compiling. -Trying to draw before the returned promise resolves, results in no action taken. -Settings can be set before promise resolution and they will be applied later.
-The descriptors of every to-be-drawn objects are required before creating the renderer, -allowing the compiler to only create the shaders that will actually be used.
-Example usage:
-
- -import { compile, hsl, CircleFactory, CircleLight } from 'sdf-2d';
const canvas = document.querySelector('canvas');
const Circle = CircleFactory(hsl(30, 66, 50));
const renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]); -Parameters
- canvas: HTMLCanvasElement
The returned renderer will only be able to draw to this canvas.
- - descriptors: DrawableDescriptor[]
The descriptor of every single object (and light) that -ever needs to be drawn by this renderer has to be given before compiling.
- - settingsOverrides: Partial<StartupSettings> = {}
Sensible defaults are provided, but these can be overridden.
-
Returns Promise<Renderer>
- canvas: HTMLCanvasElement
diff --git a/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html b/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html
deleted file mode 100644
index 8650a08..0000000
--- a/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html b/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html
deleted file mode 100644
index 4114781..0000000
--- a/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html b/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html
deleted file mode 100644
index 20997cf..0000000
--- a/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
Function InvertedTunnelFactory
- InvertedTunnelFactory(
color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number],
): typeof InvertedTunnelBaseProviding a noise texture is required for this drawable.
-Parameters
- color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
Returns typeof InvertedTunnelBase
- color:
Function MetaCircleFactory
- MetaCircleFactory(
color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number],
k?: number,
): typeof MetaCircleBaseParameters
- color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number] - k: number = 32
Returns typeof MetaCircleBase
- color:
Function NoisyPolygonFactory
- NoisyPolygonFactory(
vertexCount: number,
color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number],
): typeof PolygonBase & NoisyPolygonBaseParameters
- vertexCount: number
- color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
Returns typeof PolygonBase & NoisyPolygonBase
Function PolygonFactory
- PolygonFactory(
vertexCount: number,
color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number],
): typeof PolygonBaseParameters
- vertexCount: number
- color:
| number
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
Returns typeof PolygonBase
Function RotatedRectangleFactory
Function renderNoise
- renderNoise(
textureSize: ReadonlyVec2,
scale: number,
amplitude: number,
ignoreWebGL2?: boolean,
): Promise<HTMLCanvasElement>Create a renderer, draw a 2D noise texture with it, -then destroy the used resources, -while returning the generated texture in the form of a canvas.
-Parameters
- textureSize: ReadonlyVec2
The resolution of the end result
- - scale: number
A starting value can be 15
- - amplitude: number
A starting value can be 1
- - ignoreWebGL2: boolean = false
Ignore WebGL2, even when it's available
-
Returns Promise<HTMLCanvasElement>
- textureSize: ReadonlyVec2
Function hex
Return a color given in a hexadecimal form as a vec3.
-Parameters
- hex: string
A hexadecimal color with (#ff0000) or without (ff0000) -a leading hash mark.
-source: https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb
-
Returns vec3
- hex: string
Function hsl
Return a color contained in a vec3.
-Parameters
- hue: number
Should be between 0 and 360
- - saturation: number
Should be between 0 and 100
- - lightness: number
Should be between 0 and 100
-source: https://stackoverflow.com/questions/2353211/hsl-to-rgb-color-conversion
-
Returns vec3
- hue: number
diff --git a/docs/functions/helper_colors_rgb255.rgb255.html b/docs/functions/helper_colors_rgb255.rgb255.html
deleted file mode 100644
index 95ceca5..0000000
--- a/docs/functions/helper_colors_rgb255.rgb255.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/docs/functions/helper_colors_rgba.rgba.html b/docs/functions/helper_colors_rgba.rgba.html
deleted file mode 100644
index d8db834..0000000
--- a/docs/functions/helper_colors_rgba.rgba.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
diff --git a/docs/functions/helper_colors_rgba255.rgba255.html b/docs/functions/helper_colors_rgba255.rgba255.html
deleted file mode 100644
index f785475..0000000
--- a/docs/functions/helper_colors_rgba255.rgba255.html
+++ /dev/null
@@ -1,6 +0,0 @@
-
Function rgba255
Return a color with transparency contained in a vec4.
-Parameters
- r: number
Should be between 0 and 255
- - g: number
Should be between 0 and 255
- - b: number
Should be between 0 and 255
- - a: number
Should be between 0 and 255
-
Returns vec4
- r: number
Function runAnimation
- runAnimation(
canvas: HTMLCanvasElement,
descriptors: DrawableDescriptor[],
animate: (
renderer: Renderer,
currentTimeInMilliseconds: number,
deltaTimeInMilliseconds: number,
) => boolean,
settings?: Partial<StartupSettings & RuntimeSettings>,
): Promise<void>Implements the boilerplate code required to run real-time animations -in the browser. An FPS based autoscaler is also used. This creates an additional
-fps-key in the renderersinsightsproperty.Example usage:
-
- -<canvas id="main" style="width: 300px; height: 150px"></canvas> --
-The canvas needs to have a fixed size specified by CSS.
-
- -import { CircleFactory, CircleLight, hsl, runAnimation } from 'sdf-2d';
const canvas = document.querySelector('canvas');
const Circle = CircleFactory(hsl(180, 100, 40));
runAnimation(canvas, [Circle.descriptor, CircleLight.descriptor], (renderer, time) => {
renderer.addDrawable(
new Circle([150 + 50 * Math.cos(time / 1000), 75 + 50 * Math.sin(time / 1000)], 25)
);
renderer.addDrawable(new CircleLight([150, 75], hsl(270, 100, 40), 0.1));
return true;
}); -Parameters
- canvas: HTMLCanvasElement
The returned renderer will only be able to draw to this canvas.
- - descriptors: DrawableDescriptor[]
The descriptor of every single object (and light) that -ever needs to be drawn by this renderer has to be given before compiling.
- - animate: (
renderer: Renderer,
currentTimeInMilliseconds: number,
deltaTimeInMilliseconds: number,
) => booleanThis function will be called before rendering each frame. -
-renderDrawablesmust not be called by the animate function. It should returntrue-if the animation should be continued. To break out of the animation loop, afalse(falsy) -return value must be given. - settings: Partial<StartupSettings & RuntimeSettings> = {}
Returns Promise<void>
- canvas: HTMLCanvasElement
+
+
+
+
+ SDF-2D - v0.7.6
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
deleted file mode 100644
index 1a773b0..0000000
--- a/docs/hierarchy.html
+++ /dev/null
@@ -1 +0,0 @@
-
+
+
+
+
+
+
+
+
+
+ Texture
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const Circle
+
+
+
+ Const Droplet
+
+
+
+ Const Hexagon
+
+
+
+ Const Inverted
+
+
+
+ Const Meta
+
+
+
+ Const Noisy
+
+
+
+ Const Polygon
+
+
+
+ Const Rotated
+
+
+
+
+
+
+
+
+ Const render
+
+
+
+ run
+
+
+
+
+
+ Const default
+
+
+
+
+ ambient
+
+
+
+
+
+ color
+
+
+
+
+
+ distance
+
+
+
+
+
+ enable
+
+
+
+
+
+ is
+
+
+
+
+
+ light
+
+
+
+
+
+ lights
+
+
+
+
+
+ motion
+
+
+
+
+
+
+
+
+ tile
+
+
+
+
+
+
+ Const default
+
+
+
+
+ background
+
+
+
+
+
+ enable
+
+
+
+
+
+ enable
+
+
+
+
+
+ ignore
+
+
+
+
+
+ light
+
+
+
+
+
+ palette
+
+
+
+
+
+ shadow
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Namespaces
+-
+
- __global +
Enumerations
+-
+
- Filtering
Options
+ - Wrap
Options
+
Drawable Classes
+-
+
- Circle
Base
+ - Circle
Light
+ - Droplet
Base
+ - Flashlight +
- Hexagon
Base
+ - Inverted
Tunnel Base
+ - Meta
Circle Base
+ - Polygon
Base
+ - Rotated
Rectangle Base
+
Other Classes
+ +Interfaces
+ +Type aliases
+ +Variables
+-
+
- _id +
Color Functions
+ +Drawable Functions
+-
+
- Circle
Factory
+ - Droplet
Factory
+ - Hexagon
Factory
+ - Inverted
Tunnel Factory
+ - Meta
Circle Factory
+ - Noisy
Polygon Factory
+ - Polygon
Factory
+ - Rotated
Rectangle Factory
+
Other Functions
+-
+
- compile +
- render
Noise
+ - run
Animation
+
Object literals
+ +Type aliases
+TextureWithOptions
+
+
+
+
+ Type declaration
+-
+
-
+
overrides: Partial<TextureOptions>
+
+ -
+
source: TexImageSource
+
+
Variables
+Let _id
+ + +Color Functions
+Const hex
+-
+
+
-
+
-
+
+ ++++
Return a color given in a hexadecimal form as a vec3.
+A hexadecimal color with (#ff0000) or without (ff0000) + a leading hash mark.
+source: https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb
+Parameters
+-
+
-
+
hex: string
+
+
Returns vec3
+
+ -
+
Const hsl
+-
+
+
-
+
-
+
+ ++++
Return a color contained in a vec3.
+Parameters
+-
+
-
+
hue: number
+++++Should be between 0 and 360
+
+ -
+
saturation: number
+++++Should be between 0 and 100
+
+ -
+
lightness: number
+++++Should be between 0 and 100
+source: https://stackoverflow.com/questions/2353211/hsl-to-rgb-color-conversion
+
+
Returns vec3
+
+ -
+
Const rgb
+-
+
+
-
+
-
+
+ ++++
Return a color contained in a vec3.
+Parameters
+-
+
-
+
r: number
+++++Should be between 0 and 1
+
+ -
+
g: number
+++++Should be between 0 and 1
+
+ -
+
b: number
+++++Should be between 0 and 1
+
+
Returns vec3
+
+ -
+
Const rgb255
+-
+
+
-
+
-
+
+ ++++
Return a color contained in a vec3.
+Parameters
+-
+
-
+
r: number
+++++Should be between 0 and 255
+
+ -
+
g: number
+++++Should be between 0 and 255
+
+ -
+
b: number
+++++Should be between 0 and 255
+
+
Returns vec3
+
+ -
+
Const rgba
+-
+
+
-
+
-
+
+ ++++
Return a color with transparency contained in a vec4.
+Parameters
+-
+
-
+
r: number
+++++Should be between 0 and 1
+
+ -
+
g: number
+++++Should be between 0 and 1
+
+ -
+
b: number
+++++Should be between 0 and 1
+
+ -
+
a: number
+++++Should be between 0 and 1
+
+
Returns vec4
+
+ -
+
Const rgba255
+-
+
+
-
+
-
+
+ ++++
Return a color with transparency contained in a vec4.
+Parameters
+-
+
-
+
r: number
+++++Should be between 0 and 255
+
+ -
+
g: number
+++++Should be between 0 and 255
+
+ -
+
b: number
+++++Should be between 0 and 255
+
+ -
+
a: number
+++++Should be between 0 and 255
+
+
Returns vec4
+
+ -
+
Drawable Functions
+Const CircleFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+
Returns typeof CircleBase
+
+ -
+
Const DropletFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+
Returns typeof DropletBase
+
+ -
+
Const HexagonFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+
Returns typeof HexagonBase
+
+ -
+
Const InvertedTunnelFactory
+ -
+
+
-
+
-
+
+ ++++
Providing a noise texture is required for this drawable.
+Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+
Returns typeof InvertedTunnelBase
+
+ -
+
Const MetaCircleFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+ -
+
Default value k: number = 32
+
+
Returns typeof MetaCircleBase
+
+ -
+
Const NoisyPolygonFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
vertexCount: number
+
+ -
+
color: vec3 | vec4 | number
+
+
Returns typeof PolygonBase & NoisyPolygonBase
+
+ -
+
Const PolygonFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
vertexCount: number
+
+ -
+
color: vec3 | vec4 | number
+
+
Returns typeof PolygonBase
+
+ -
+
Const RotatedRectangleFactory
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
color: vec3 | vec4 | number
+
+
Returns typeof RotatedRectangleBase
+
+ -
+
Other Functions
+compile
+-
+
+
-
+
-
+
+ ++++
Compiles a new renderer instance. There can multiple renderers on a single page.
++
+Asynchronous behaviour is required for parallel shader compiling. + Trying to draw before the returned promise resolves, results in no action taken. + Settings can be set before promise resolution and they will be applied later.
+The descriptors of every to-be-drawn objects are required before creating the renderer, + allowing the compiler to only create the shaders that will actually be used.
+Example usage:
+import { compile, hsl, CircleFactory, CircleLight } from 'sdf-2d'; + + const canvas = document.querySelector('canvas'); + const Circle = CircleFactory(hsl(30, 66, 50)); + const renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]); +Parameters
+-
+
-
+
canvas: HTMLCanvasElement
+++The returned renderer will only be able to draw to this canvas.
+
+ -
+
descriptors: Array<DrawableDescriptor>
+++The descriptor of every single object (and light) that + ever needs to be drawn by this renderer has to be given before compiling.
+
+ -
+
Default value settingsOverrides: Partial<StartupSettings> = {}
+++Sensible defaults are provided, but these can be overridden.
+
+
Returns Promise<Renderer>
+
+ -
+
Const renderNoise
+ -
+
+
-
+
-
+
+ ++++
Create a renderer, draw a 2D noise texture with it, + then destroy the used resources, + while returning the generated texture in the form of a canvas.
+Parameters
+-
+
-
+
textureSize: ReadonlyVec2
+++++The resolution of the end result
+
+ -
+
scale: number
+++++A starting value can be 15
+
+ -
+
amplitude: number
+++++A starting value can be 1
+
+ -
+
Default value ignoreWebGL2: boolean = false
+++++Ignore WebGL2, even when it's available
+
+
Returns Promise<HTMLCanvasElement>
+
+ -
+
runAnimation
+ -
+
+
-
+
-
+
+ ++++
Implements the boilerplate code required to run real-time animations + in the browser. An FPS based autoscaler is also used. This creates an additional
+fps+ key in the renderersinsightsproperty.Example usage:
+<canvas id="main" style="width: 300px; height: 150px"></canvas> ++
+The canvas needs to have a fixed size specified by CSS.
+import { CircleFactory, CircleLight, hsl, runAnimation } from 'sdf-2d'; + +const canvas = document.querySelector('canvas'); +const Circle = CircleFactory(hsl(180, 100, 40)); + +runAnimation(canvas, [Circle.descriptor, CircleLight.descriptor], (renderer, time) => { + renderer.addDrawable( + new Circle([150 + 50 * Math.cos(time / 1000), 75 + 50 * Math.sin(time / 1000)], 25) + ); + renderer.addDrawable(new CircleLight([150, 75], hsl(270, 100, 40), 0.1)); + return true; +}); +Parameters
+-
+
-
+
canvas: HTMLCanvasElement
+++The returned renderer will only be able to draw to this canvas.
+
+ -
+
descriptors: Array<DrawableDescriptor>
+++The descriptor of every single object (and light) that + ever needs to be drawn by this renderer has to be given before compiling.
+
+ -
+
animate: (renderer: Renderer, currentTimeInMilliseconds: DOMHighResTimeStamp, deltaTimeInMilliseconds: DOMHighResTimeStamp) => boolean
+++This function will be called before rendering each frame. +
+renderDrawablesmust not be called by the animate function. It should returntrue+ if the animation should be continued. To break out of the animation loop, afalse(falsy) + return value must be given.-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
renderer: Renderer
+
+ -
+
currentTimeInMilliseconds: DOMHighResTimeStamp
+
+ -
+
deltaTimeInMilliseconds: DOMHighResTimeStamp
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
-
+
Default value settings: Partial<StartupSettings & RuntimeSettings> = {}
+
+
Returns Promise<void>
+
+ -
+
Object literals
+Const defaultRuntimeSettings
+
+
+
+
+
+
+ Contains the default values used for RuntimeSettings.
+ambientLight
+
+
+ colorPalette
+
+
+ distanceRenderScale
+
+
+ enableHighDpiRendering
+
+
+ isWorldInverted
+
+
+ lightCutoffDistance
+
+
+ lightsRenderScale
+
+
+ motionBlur
+
+
+ textures
+ + +
+
+ Type declaration
+-
+
tileMultiplier
+
+
+ Const defaultStartupSettings
+
+
+
+
+
+
+ Contains the default values used for StartupSettings.
+backgroundColor
+
+
+ enableContextLostSimulator
+
+
+ enableStopwatch
+
+
+ ignoreWebGL2
+
+
+ lightPenetrationRatio
+
+
+ paletteSize
+
+
+ shadowTraceCount
+
+
+
diff --git a/docs/index.html b/docs/index.html
index 8c5d546..4f266ca 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,53 +1,318 @@
-
SDF-2D - v0.7.6
Documentation
-The motivation behind this library and more in-depth information about the rendering techniques utilised can be found in my thesis.
-Links
- -Usage (1st option)
--
-
- To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the compile function.
-
-
-
- For this, some DrawableDescriptors has to be provided. -
- Optionally, default compile settings can overridden using StartupSettings. -
- - After acquiring a renderer, the drawing of objects can be started through the Renderer interface. -
Usage (2nd option)
-If you're planning on creating animated content, use the runAnimation function to spare yourself from writing boilerplate code. -Further documentation on its usage is available in its documentation.
-Extending drawables
---Iñigo Quilez has some great 2D SDF-s
-
-
-
- Subclass Drawable -
- Implement its abstract methods -
- Add a static property to your class called
descriptorof type DrawableDescriptors
- - Follow the instructions given in Usage -
Useful to know
-Math
-The vec2, vec3, and vec4 types seen in the documentation come from the glMatrix library and are equivalent to regular JS Arrays or Float32Arrays. So, feel free to give [x, y] as an input for functions requiring vec2.
Coordinates
-Anywhere, where positions need to be specified, the y values grow upwards. That means, when setting the view area, the origin is at the bottom left corner of the display.
Tile-based rendering
-For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shaders for each tile are compiled to support a fix maximum number of objects on it. When using the built-in drawables it is possible that after a certain number of on-screen objects new ones won't be visible.
-Mitigating this issue is quite easy. Instead of the following code:
-this.renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
-Modify it to something similar:
-this.renderer = await compile(canvas, [
{
...Circle.descriptor,
shaderCombinationSteps: [0, 1, 2, 24, 64],
},
{
...CircleLight.descriptor,
shaderCombinationSteps: [0, 1, 2, 4],
},
]);
-The usage of too large numbers is not advised for compatibility and performance reasons alike.
---Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necessary number of objects on each tile.
-
+
+
+
+
+ SDF-2D - v0.7.6
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/__global.array.html b/docs/interfaces/__global.array.html
new file mode 100644
index 0000000..4a23bb7
--- /dev/null
+++ b/docs/interfaces/__global.array.html
@@ -0,0 +1,191 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documentation
+
+ The motivation behind this library and more in-depth information about the rendering techniques utilised can be found in my thesis.
+ +Links
+ + + +Usage (1st option)
+ +-
+
- To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the compile function.
-
+
- For this, some DrawableDescriptors has to be provided. +
- Optionally, default compile settings can overridden using StartupSettings. +
+ - After acquiring a renderer, the drawing of objects can be started through the Renderer interface. +
Usage (2nd option)
+ +If you're planning on creating animated content, use the runAnimation function to spare yourself from writing boilerplate code. + Further documentation on its usage is available in its documentation.
+ +Extending drawables
+ +++Iñigo Quilez has some great 2D SDF-s
+
-
+
- Subclass Drawable +
- Implement its abstract methods +
- Add a static property to your class called
descriptorof type DrawableDescriptors
+ - Follow the instructions given in Usage +
Useful to know
+ + +Math
+ +The vec2, vec3, and vec4 types seen in the documentation come from the glMatrix library and are equivalent to regular JS Arrays or Float32Arrays. So, feel free to give [x, y] as an input for functions requiring vec2.
Coordinates
+ +Anywhere, where positions need to be specified, the y values grow upwards. That means, when setting the view area, the origin is at the bottom left corner of the display.
Tile-based rendering
+ +For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shaders for each tile are compiled to support a fix maximum number of objects on it. When using the built-in drawables it is possible that after a certain number of on-screen objects new ones won't be visible.
+Mitigating this issue is quite easy. Instead of the following code:
+this.renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
+Modify it to something similar:
+this.renderer = await compile(canvas, [
+ {
+ ...Circle.descriptor,
+ shaderCombinationSteps: [0, 1, 2, 24, 64],
+ },
+ {
+ ...CircleLight.descriptor,
+ shaderCombinationSteps: [0, 1, 2, 4],
+ },
+]);
+The usage of too large numbers is not advised for compatibility and performance reasons alike.
+++Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necessary number of objects on each tile.
+
+
+
+
+
+ Interface Array<T>
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/__global.float32array.html b/docs/interfaces/__global.float32array.html
new file mode 100644
index 0000000..4f359fb
--- /dev/null
+++ b/docs/interfaces/__global.float32array.html
@@ -0,0 +1,183 @@
+
+
+
+
+
+
+
+
+
+
+ Interface Float32Array
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/__global.readonlyarray.html b/docs/interfaces/__global.readonlyarray.html
new file mode 100644
index 0000000..d0b0471
--- /dev/null
+++ b/docs/interfaces/__global.readonlyarray.html
@@ -0,0 +1,191 @@
+
+
+
+
+
+
+
+
+
+
+ Interface ReadonlyArray<T>
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/drawabledescriptor.html b/docs/interfaces/drawabledescriptor.html
new file mode 100644
index 0000000..fde937a
--- /dev/null
+++ b/docs/interfaces/drawabledescriptor.html
@@ -0,0 +1,284 @@
+
+
+
+
+
+
+
+
+
+
+ Interface DrawableDescriptor
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html b/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html
deleted file mode 100644
index 6200b4b..0000000
--- a/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html
+++ /dev/null
@@ -1,34 +0,0 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional object
+
+
+
+
+
+ property
+
+
+
+
+
+
+
+
+ shader
+
+
+
+
+
+ uniform
+
+
+
+
+
+
+
+
+
+
+ Used for containing the required information to compile drawables into + shader code.
+Each Drawable must have a static property of this type, called descriptor.
+For more information on how to create your own DrawableDescriptor-s, look at the + code of CircleFactory or InvertedTunnelFactory.
+Hierarchy
+-
+
- + DrawableDescriptor + +
Index
+
+
+
+
+ Properties
+ +Properties
+Readonly empty
+ + +
+
+
+
+ When no shaderCombinationStep matches the current number of drawables exactly,
+ the value of empty is used to pad out arrays.
Optional objectCountScaler
+
+
+
+
+
+
+ Calculating the number of objects to be drawn is done using the following pseudo-formula:
+objectCountScaler * propertyUniformMapping[0].length
+By default, its value is 1
+propertyUniformMapping
+
+
+
+
+
+
+ An object describing the relationship between the object returned by a Drawable's + getObjectToSerialize and the name of the arrays used in the GLSL code.
+
+
+ Type declaration
+-
+
-
+
[property: string]: string
+
+
Optional sdf
+ + +
+
+
+
+ Required property for shapes having physical dimensions.
+shaderCombinationSteps
+
+
+
+
+
+
+ Number of possible drawables around each tile.
+For each step, a shader will be generated. And at runtime the closes matching + shader will be used to render a given part of the scene.
+Must contain 0 as a value.
+uniformCountMacroName
+
+
+
+
+
+
+ The name of the uniform int used in the code to refer to the + number of drawables of this type.
+Interface DrawableDescriptor
Used for containing the required information to compile drawables into -shader code.
-Each [[Drawable]] must have a static property of this type, called descriptor.
-For more information on how to create your own DrawableDescriptor-s, look at the -code of [[CircleFactory]] or [[InvertedTunnelFactory]].
-interface DrawableDescriptor {
empty: Drawable;
objectCountScaler?: number;
propertyUniformMapping: { [property: string]: string };
sdf?: {
distanceFunctionName: string;
isInverted?: boolean;
shader: string;
};
shaderCombinationSteps: number[];
uniformCountMacroName: string;
}
empty: Drawable;
objectCountScaler?: number;
propertyUniformMapping: { [property: string]: string };
sdf?: {
distanceFunctionName: string;
isInverted?: boolean;
shader: string;
};
shaderCombinationSteps: number[];
uniformCountMacroName: string;
}
Index
Properties
Readonlyempty
When no shaderCombinationStep matches the current number of drawables exactly,
-the value of empty is used to pad out arrays.
Optionalobject
objectCountScaler?: number
Calculating the number of objects to be drawn is done using the following pseudo-formula:
-objectCountScaler * propertyUniformMapping[0].length
-By default, its value is 1
-property
propertyUniformMapping: { [property: string]: string }
An object describing the relationship between the object returned by a [[Drawable]]'s -getObjectToSerialize and the name of the arrays used in the GLSL code.
-Optionalsdf
sdf?: { distanceFunctionName: string; isInverted?: boolean; shader: string }
Required property for shapes having physical dimensions.
-Type Declaration
distanceFunctionName: string
The name of the function defined in the value of
-shader. -Its signature should look like this:
- -float (in vec2 target, out float colorIndex) -OptionalisInverted?: booleanBy default, drawables are not inverted.
-shader: string
The actual GLSL code for observing the drawables represented by this descriptor.
-Your code should work with both version 100 and version 300 es
-
shader
shaderCombinationSteps: number[]
Number of possible drawables around each tile.
-For each step, a shader will be generated. And at runtime the closes matching -shader will be used to render a given part of the scene.
-Must contain 0 as a value.
-uniform
uniformCountMacroName: string
The name of the uniform int used in the code to refer to the -number of drawables of this type.
-Interface TextureOptions
interface TextureOptions {
maxFilter: FilteringOptions;
minFilter: FilteringOptions;
wrapS: WrapOptions;
wrapT: WrapOptions;
}
maxFilter: FilteringOptions;
minFilter: FilteringOptions;
wrapS: WrapOptions;
wrapT: WrapOptions;
}
Interface RendererInfo
interface RendererInfo {
extensions: { [name: string]: boolean };
floatInterpolationEnabled?: boolean;
isWebGL2: boolean;
programCount?: number;
renderer?: string;
renderPasses: {
distance: {
drawableCount?: number;
drawnDrawableCount?: number;
renderScale?: number;
tileCount?: number;
};
lights: { drawnDrawableCount?: number; renderScale?: number };
};
sdf2dVersion?: string;
startupTimeInMilliseconds?: number;
vendor?: string;
[k: string]: any;
}
extensions: { [name: string]: boolean };
floatInterpolationEnabled?: boolean;
isWebGL2: boolean;
programCount?: number;
renderer?: string;
renderPasses: {
distance: {
drawableCount?: number;
drawnDrawableCount?: number;
renderScale?: number;
tileCount?: number;
};
lights: { drawnDrawableCount?: number; renderScale?: number };
};
sdf2dVersion?: string;
startupTimeInMilliseconds?: number;
vendor?: string;
[k: string]: any;
}
Indexable
- [k: string]: any
Index
Properties
extensions
extensions: { [name: string]: boolean }
Optionalfloat
floatInterpolationEnabled?: boolean
is
isWebGL2: boolean
Optionalprogram
programCount?: number
Optionalrenderer
renderer?: string
render
renderPasses: {
distance: {
drawableCount?: number;
drawnDrawableCount?: number;
renderScale?: number;
tileCount?: number;
};
lights: { drawnDrawableCount?: number; renderScale?: number };
}
distance: {
drawableCount?: number;
drawnDrawableCount?: number;
renderScale?: number;
tileCount?: number;
};
lights: { drawnDrawableCount?: number; renderScale?: number };
}
Optionalsdf2d
sdf2dVersion?: string
Optionalstartup
startupTimeInMilliseconds?: number
Optionalvendor
vendor?: string
Interface Renderer
The main interface through which rendering can be achieved.
-Multiple renderers are permitted on a single page.
-interface Renderer {
canvasSize: ReadonlyVec2;
insights: RendererInfo | null;
viewAreaSize: ReadonlyVec2;
addDrawable<T extends Drawable>(drawable: T): void;
destroy(): void;
displayToWorldCoordinates(displayCoordinates: ReadonlyVec2): vec2;
renderDrawables(): void;
setRuntimeSettings(overrides: Partial<RuntimeSettings>): void;
setViewArea(topLeft: ReadonlyVec2, size: ReadonlyVec2): void;
worldToDisplayCoordinates(worldCoordinates: ReadonlyVec2): vec2;
}
canvasSize: ReadonlyVec2;
insights: RendererInfo | null;
viewAreaSize: ReadonlyVec2;
addDrawable<T extends Drawable>(drawable: T): void;
destroy(): void;
displayToWorldCoordinates(displayCoordinates: ReadonlyVec2): vec2;
renderDrawables(): void;
setRuntimeSettings(overrides: Partial<RuntimeSettings>): void;
setViewArea(topLeft: ReadonlyVec2, size: ReadonlyVec2): void;
worldToDisplayCoordinates(worldCoordinates: ReadonlyVec2): vec2;
}
Index
Properties
Methods
Properties
Readonlycanvas
canvasSize: ReadonlyVec2
Get the actual resolution of the canvas without triggering a reflow.
-A ResizeObserver is utilised fot achieving this.
-Readonlyinsights
Get useful information about the hardware and the SDF2D renderer.
-Its scheme is subject to change.
-During context lost it might be null.
-Readonlyview
viewAreaSize: ReadonlyVec2
Get the viewArea size set by the last setViewArea.
By default, canvasSize is used for the view area size.
Methods
add
destroy
Let go of every GPU resource held by the renderer.
-It's up to the browser and driver whether these resources are actually freed. -Nonetheless, when a renderer is no longer needed, this method should be called.
-Returns void
display
The inverse of
-worldToDisplayCoordinates, returns the world coordinates -from a pixel's position.The view area coordinates are also given in world coordinates.
-Useful for picking.
-Parameters
- displayCoordinates: ReadonlyVec2
The origin is in the display's top left corner. -Just as in mouse events' clientX and clientY.
-
Returns vec2
- displayCoordinates: ReadonlyVec2
render
Render every drawable added since the last
-renderDrawablescall.Resizing of framebuffers and the canvas also takes effect -when calling
-renderDrawables.Returns void
set
Patch the current runtime settings with new values.
-Parameters
- overrides: Partial<RuntimeSettings>
Returns void
set
Set the camera transformation.
-Parameters
- topLeft: ReadonlyVec2
top (!) left. By default, equals to [0, canvasHeight].
- - size: ReadonlyVec2
need not be equal to the canvas size, though their aspect ratio -should be the same to avoid stretching.
-
Returns void
- topLeft: ReadonlyVec2
world
The inverse of
-displayToWorldCoordinates, returns the screen space position -of a point given in world space coordinates.While the origin for worldCoordinates resides in the bottom-left corner, -the origin of the returned display coordinates is placed in the top left.
-Parameters
- worldCoordinates: ReadonlyVec2
Coordinates used when drawing objects.
-
Returns vec2
- worldCoordinates: ReadonlyVec2
Interface RuntimeSettings
Interface for a configuration object containing the settings -that can be changed during runtime.
-The default values for RuntimeSettings can be found in [[defaultRuntimeSettings]].
-interface RuntimeSettings {
ambientLight: vec3;
colorPalette: (
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
)[];
distanceRenderScale: number;
enableHighDpiRendering: boolean;
isWorldInverted: boolean;
lightCutoffDistance: number;
lightsRenderScale: number;
motionBlur: number;
textures: { [textureName: string]: TexImageSource | TextureWithOptions };
tileMultiplier: number;
}
ambientLight: vec3;
colorPalette: (
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
)[];
distanceRenderScale: number;
enableHighDpiRendering: boolean;
isWorldInverted: boolean;
lightCutoffDistance: number;
lightsRenderScale: number;
motionBlur: number;
textures: { [textureName: string]: TexImageSource | TextureWithOptions };
tileMultiplier: number;
}
Properties
ambient
ambientLight: vec3
A light affecting every pixel (even the ones inside objects).
-color
colorPalette: (
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
)[]
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
)[]
Its length should be less than the one specified in [[StartupSettings]].paletteSize.
-The possible colors for the objects. Each color is referenced by its index in the -palette.
-Can have transparency, but only if WebGL2 support is enabled.
-distance
distanceRenderScale: number
The resolution of the distance field rendering will be scaled up or down with this value.
-Because of interpolation, this can be set much lower than the lightsRenderScale, while
-maintaining closely the same perceived quality.
Setting this is a great way to balance quality and performance.
-enable
enableHighDpiRendering: boolean
When set to true rendering will be done on the screen's real resolution.
is
isWorldInverted: boolean
By default, every pixel is outside of objects. Flipping this value to true will
-result in every pixel being inside a large object. From then it only makes sense to
-draw inverted objects.
light
lightCutoffDistance: number
When lights reach the end of the display, they are slowly faded out. The length -of this phaseout can be set through this value.
-lights
lightsRenderScale: number
The resolution of the final frame will be scaled by this value.
-Setting this is a great way to balance quality and performance.
-motion
motionBlur: number
Set the extent of the motion blur.
-The values must be between 0 and 1. Where 0 means no motion blur, -and values just below 1 mean an extreme amount of motion blur.
-textures
It is possible to use your own textures in your SDF definitions.
-The keys of the object should be the name used to reference them in the GLSL code, -and the values should be the textures themselves or a TextureWithOptions specifying -the texture's [[TextureOptions]]. -It can be a canvas, img element, Image and so on.
-tile
tileMultiplier: number
First, the SDF of the scene is evaluated at every single pixel. -For speeding this process up, the screen is divided up into tiles, -this way each having to deal with a fewer objects.
-For each tile, it is decided which objects are near its close vicinity. -This comes with some overhead for the CPU, while saving the GPU from loads of -calculations. The workload can be balanced between the CPU and the GPU by setting -this number.
-Interface StartupSettings
Interface for a configuration object containing the settings -that need to be given before shader compilation.
-The default values for StartupSettings can be found in [[defaultStartupSettings]].
-interface StartupSettings {
backgroundColor:
| IndexedCollection
| [number, number, number]
| [number, number, number, number];
enableContextLostSimulator: boolean;
enableStopwatch: boolean;
ignoreWebGL2: boolean;
lightOverlapReduction: number;
lightPenetrationRatio: number;
paletteSize: number;
shadowTraceCount: number;
}
backgroundColor:
| IndexedCollection
| [number, number, number]
| [number, number, number, number];
enableContextLostSimulator: boolean;
enableStopwatch: boolean;
ignoreWebGL2: boolean;
lightOverlapReduction: number;
lightPenetrationRatio: number;
paletteSize: number;
shadowTraceCount: number;
}
Properties
background
backgroundColor:
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
| IndexedCollection
| [number, number, number]
| [number, number, number, number]
The default background color of the scene, can have transparency on every platform.
-enable
enableContextLostSimulator: boolean
Many context lost event will be simulated when enabled.
-Useful for testing.
-enable
enableStopwatch: boolean
Creates a stopwatch used for measuring the GPU render time -when its required extension is available.
-You should only have one renderer with enabled stopwatch.
-ignore
ignoreWebGL2: boolean
When set to true, rendering will fall back to WebGL
-even when WebGL2 is present.
Useful for testing compatibility.
-light
lightOverlapReduction: number
Controls how overlapping lights combine.
-At 0 lights are summed additively (the physically-correct default):
-two nearby lights brighten their overlap and their glows merge into a
-shape larger than either alone. At 1 overlapping lights instead take
-the per-channel maximum, so a combination never reads brighter or larger
-than its strongest contributor. Values in between blend the two.
A single light looks the same at any value. Should be between 0 and 1.
-light
lightPenetrationRatio: number
The illumination is multiplied by this constant where -the distance field is negative (i.e. inside objects).
-Should be between 0 and 1, but other values are also permitted.
-palette
paletteSize: number
Gives the number of possible object colors for the scene.
-When using WebGL, only 256 different colors can be used. -On WebGL2, its value should not be larger than 4096 for -maintaining compatibility with low-end devices.
-shadow
shadowTraceCount: number
The raytracing algorithm used for shadows requires a step count. -Sensible values for this are between 8 and 32.
-The higher the number, the harder the shadows will get. -Some ambient occlusion like effects can be visible on lower trace counts.
-
+
+
+
+
+ Interface NoisyPolygonBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/renderer.html b/docs/interfaces/renderer.html
new file mode 100644
index 0000000..8192a07
--- /dev/null
+++ b/docs/interfaces/renderer.html
@@ -0,0 +1,471 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ random
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected get
+
+
+
+ min
+
+
+
+
+ Hierarchy
+-
+
-
+ PolygonBase
+
-
+
- + NoisyPolygonBase + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- random
Offset
+ - vertices +
- descriptor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
vertices: Array<vec2>
+
+
Returns NoisyPolygonBase
+
+ -
+
Properties
+randomOffset
+
+
+ vertices
+ + +Static Readonly descriptor
+ + +Methods
+Protected getObjectToSerialize
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
transform2d: mat2d
+
+ -
+
transform1d: number
+
+
Returns any
+
+ -
+
minDistance
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: vec2
+
+
Returns number
+
+ -
+
+
+
+
+
+ Interface Renderer
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/rendererinfo.html b/docs/interfaces/rendererinfo.html
new file mode 100644
index 0000000..b31724c
--- /dev/null
+++ b/docs/interfaces/rendererinfo.html
@@ -0,0 +1,314 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly canvas
+
+
+
+
+
+
+
+
+ Readonly view
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ display
+
+
+
+ render
+
+
+
+ set
+
+
+
+ set
+
+
+
+ world
+
+
+
+
+
+
+
+
+ The main interface through which rendering can be achieved.
+Multiple renderers are permitted on a single page.
+Hierarchy
+-
+
- + Renderer + +
Index
+
+
+
+
+
+
+ Properties
+-
+
- canvas
Size
+ - insights +
- view
Area Size
+
Methods
+ +Properties
+Readonly canvasSize
+
+
+
+
+
+
+ Get the actual resolution of the canvas without triggering a reflow.
+A ResizeObserver is utilised fot achieving this.
+Readonly insights
+ + +
+
+
+
+ Get useful information about the hardware and the SDF2D renderer.
+Its scheme is subject to change.
+During context lost it might be null.
+Readonly viewAreaSize
+
+
+
+
+
+
+ Get the viewArea size set by the last setViewArea.
By default, canvasSize is used for the view area size.
Methods
+addDrawable
+ -
+
+
-
+
-
+
+ ++++
Schedule a drawable to be rendered during the next
+renderDrawablescall.Type parameters
+-
+
-
+
T: Drawable
+
+
Parameters
+-
+
-
+
drawable: T
+++Must be a subclass of drawable and its class must contain a + static descriptor property of type DrawableDescriptor.
+
+
Returns void
+
+ -
+
destroy
+-
+
+
-
+
-
+
+ ++++
Let go of every GPU resource held by the renderer.
+It's up to the browser and driver whether these resources are actually freed. + Nonetheless, when a renderer is no longer needed, this method should be called.
+Returns void
+
+
displayToWorldCoordinates
+ -
+
+
-
+
-
+
+ ++++
The inverse of
+worldToDisplayCoordinates, returns the world coordinates + from a pixel's position.The view area coordinates are also given in world coordinates.
+Useful for picking.
+Parameters
+-
+
-
+
displayCoordinates: ReadonlyVec2
+++The origin is in the display's top left corner. + Just as in mouse events' clientX and clientY.
+
+
Returns vec2
+
+ -
+
renderDrawables
+ -
+
+
-
+
-
+
+ ++++
Render every drawable added since the last
+renderDrawablescall.Resizing of framebuffers and the canvas also takes effect + when calling
+renderDrawables.Returns void
+
+
setRuntimeSettings
+ -
+
+
-
+
-
+
+ ++++
Patch the current runtime settings with new values.
+Parameters
+-
+
-
+
overrides: Partial<RuntimeSettings>
+++
+
Returns void
+
+ -
+
setViewArea
+ -
+
+
-
+
-
+
+ ++++
Set the camera transformation.
+Parameters
+-
+
-
+
topLeft: ReadonlyVec2
+++top (!) left. By default, equals to [0, canvasHeight].
+
+ -
+
size: ReadonlyVec2
+++need not be equal to the canvas size, though their aspect ratio + should be the same to avoid stretching.
+
+
Returns void
+
+ -
+
worldToDisplayCoordinates
+ -
+
+
-
+
-
+
+ ++++
The inverse of
+displayToWorldCoordinates, returns the screen space position + of a point given in world space coordinates.While the origin for worldCoordinates resides in the bottom-left corner, + the origin of the returned display coordinates is placed in the top left.
+Parameters
+-
+
-
+
worldCoordinates: ReadonlyVec2
+++Coordinates used when drawing objects.
+
+
Returns vec2
+
+ -
+
+
+
+
+
+ Interface RendererInfo
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/runtimesettings.html b/docs/interfaces/runtimesettings.html
new file mode 100644
index 0000000..f35fde9
--- /dev/null
+++ b/docs/interfaces/runtimesettings.html
@@ -0,0 +1,372 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional float
+
+
+
+
+
+ is
+
+
+
+
+
+ Optional program
+
+
+
+
+
+ render
+
+
+
+
+
+
+
+
+ Optional sdf2d
+
+
+
+
+
+ Optional startup
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + RendererInfo + +
Indexable
+ +Index
+
+
+
+
+ Properties
+ +Properties
+extensions
+ + +
+
+ Type declaration
+-
+
-
+
[name: string]: boolean
+
+
Optional floatInterpolationEnabled
+
+
+ isWebGL2
+
+
+ Optional programCount
+
+
+ renderPasses
+
+
+
+
+ Type declaration
+-
+
-
+
distance: { drawableCount?: undefined | number; drawnDrawableCount?: undefined | number; renderScale?: undefined | number; tileCount?: undefined | number }
+-
+
-
+
Optional drawable
+Count?: undefined | number
+ -
+
Optional drawn
+Drawable Count?: undefined | number
+ -
+
Optional render
+Scale?: undefined | number
+ -
+
Optional tile
+Count?: undefined | number
+
+ -
+
-
+
lights: { drawnDrawableCount?: undefined | number; renderScale?: undefined | number }
+-
+
-
+
Optional drawn
+Drawable Count?: undefined | number
+ -
+
Optional render
+Scale?: undefined | number
+
+ -
+
Optional renderer
+ + +Optional sdf2dVersion
+
+
+ Optional startupTimeInMilliseconds
+
+
+ Optional vendor
+ + +
+
+
+
+
+ Interface RuntimeSettings
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/startupsettings.html b/docs/interfaces/startupsettings.html
new file mode 100644
index 0000000..00648fa
--- /dev/null
+++ b/docs/interfaces/startupsettings.html
@@ -0,0 +1,298 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ambient
+
+
+
+
+
+ color
+
+
+
+
+
+ distance
+
+
+
+
+
+ enable
+
+
+
+
+
+ is
+
+
+
+
+
+ light
+
+
+
+
+
+ lights
+
+
+
+
+
+ motion
+
+
+
+
+
+
+
+
+ tile
+
+
+
+
+
+
+
+
+
+
+ Interface for a configuration object containing the settings + that can be changed during runtime.
+The default values for RuntimeSettings can be found in defaultRuntimeSettings.
+Hierarchy
+-
+
- + RuntimeSettings + +
Index
+
+
+
+
+ Properties
+ +Properties
+ambientLight
+
+
+
+
+
+
+ A light affecting every pixel (even the ones inside objects).
+colorPalette
+
+
+
+
+
+
+ Its length should be less than the one specified in StartupSettings.paletteSize.
+The possible colors for the objects. Each color is referenced by its index in the + palette.
+Can have transparency, but only if WebGL2 support is enabled.
+distanceRenderScale
+
+
+
+
+
+
+ The resolution of the distance field rendering will be scaled up or down with this value.
+Because of interpolation, this can be set much lower than the lightsRenderScale, while
+ maintaining closely the same perceived quality.
Setting this is a great way to balance quality and performance.
+enableHighDpiRendering
+
+
+
+
+
+
+ When set to true rendering will be done on the screen's real resolution.
isWorldInverted
+
+
+
+
+
+
+ By default, every pixel is outside of objects. Flipping this value to true will
+ result in every pixel being inside a large object. From then it only makes sense to
+ draw inverted objects.
lightCutoffDistance
+
+
+
+
+
+
+ When lights reach the end of the display, they are slowly faded out. The length + of this phaseout can be set through this value.
+lightsRenderScale
+
+
+
+
+
+
+ The resolution of the final frame will be scaled by this value.
+Setting this is a great way to balance quality and performance.
+motionBlur
+
+
+
+
+
+
+ Set the extent of the motion blur.
+The values must be between 0 and 1. Where 0 means no motion blur, + and values just below 1 mean an extreme amount of motion blur.
+textures
+ + +
+
+
+
+ It is possible to use your own textures in your SDF definitions.
+The keys of the object should be the name used to reference them in the GLSL code, + and the values should be the textures themselves or a TextureWithOptions specifying + the texture's TextureOptions. + It can be a canvas, img element, Image and so on.
+
+
+ Type declaration
+-
+
-
+
[textureName: string]: TexImageSource | TextureWithOptions
+
+
tileMultiplier
+
+
+
+
+
+
+ First, the SDF of the scene is evaluated at every single pixel. + For speeding this process up, the screen is divided up into tiles, + this way each having to deal with a fewer objects.
+For each tile, it is decided which objects are near its close vicinity. + This comes with some overhead for the CPU, while saving the GPU from loads of + calculations. The workload can be balanced between the CPU and the GPU by setting + this number.
+
+
+
+
+
+ Interface StartupSettings
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/interfaces/textureoptions.html b/docs/interfaces/textureoptions.html
new file mode 100644
index 0000000..9e54d16
--- /dev/null
+++ b/docs/interfaces/textureoptions.html
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ background
+
+
+
+
+
+ enable
+
+
+
+
+
+ enable
+
+
+
+
+
+ ignore
+
+
+
+
+
+ light
+
+
+
+
+
+ palette
+
+
+
+
+
+ shadow
+
+
+
+
+
+
+
+
+
+
+ Interface for a configuration object containing the settings + that need to be given before shader compilation.
+The default values for StartupSettings can be found in defaultStartupSettings.
+Hierarchy
+-
+
- + StartupSettings + +
Index
+
+
+
+
+ Properties
+ +Properties
+backgroundColor
+
+
+
+
+
+
+ The default background color of the scene, can have transparency on every platform.
+enableContextLostSimulator
+
+
+
+
+
+
+ Many context lost event will be simulated when enabled.
+Useful for testing.
+enableStopwatch
+
+
+
+
+
+
+ Creates a stopwatch used for measuring the GPU render time + when its required extension is available.
+You should only have one renderer with enabled stopwatch.
+ignoreWebGL2
+
+
+
+
+
+
+ When set to true, rendering will fall back to WebGL
+ even when WebGL2 is present.
Useful for testing compatibility.
+lightPenetrationRatio
+
+
+
+
+
+
+ The illumination is multiplied by this constant where + the distance field is negative (i.e. inside objects).
+Should be between 0 and 1, but other values are also permitted.
+paletteSize
+
+
+
+
+
+
+ Gives the number of possible object colors for the scene.
+When using WebGL, only 256 different colors can be used. + On WebGL2, its value should not be larger than 4096 for + maintaining compatibility with low-end devices.
+shadowTraceCount
+
+
+
+
+
+
+ The raytracing algorithm used for shadows requires a step count. + Sensible values for this are between 8 and 32.
+The higher the number, the harder the shadows will get. + Some ambient occlusion like effects can be visible on lower trace counts.
+
+
+
+
+
+ Interface TextureOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/media/circles-screenshot.png b/docs/media/circles-screenshot.png
new file mode 100644
index 0000000..9744afb
Binary files /dev/null and b/docs/media/circles-screenshot.png differ
diff --git a/docs/media/favicon.ico b/docs/media/favicon.ico
new file mode 100644
index 0000000..b54e780
Binary files /dev/null and b/docs/media/favicon.ico differ
diff --git a/docs/media/logo-white.svg b/docs/media/logo-white.svg
new file mode 100644
index 0000000..f6f9c79
--- /dev/null
+++ b/docs/media/logo-white.svg
@@ -0,0 +1,42 @@
+
diff --git a/docs/media/mobile-screenshots.png b/docs/media/mobile-screenshots.png
new file mode 100644
index 0000000..ab459da
Binary files /dev/null and b/docs/media/mobile-screenshots.png differ
diff --git a/docs/media/tunnels-screenshot.png b/docs/media/tunnels-screenshot.png
new file mode 100644
index 0000000..5d0e6cc
Binary files /dev/null and b/docs/media/tunnels-screenshot.png differ
diff --git a/docs/modules.html b/docs/modules.html
deleted file mode 100644
index 9ee61a9..0000000
--- a/docs/modules.html
+++ /dev/null
@@ -1 +0,0 @@
-SDF-2D - v0.7.6
Modules
- compile
- drawables/drawable
- drawables/drawable-descriptor
- drawables/empty-drawable
- drawables/lights/circle-light
- drawables/lights/flashlight
- drawables/lights/light-drawable
- drawables/shapes/circle-factory
- drawables/shapes/colorful-circle
- drawables/shapes/droplet-factory
- drawables/shapes/hexagon-factory
- drawables/shapes/inverted-tunnel-factory
- drawables/shapes/meta-circle-factory
- drawables/shapes/noisy-polygon-factory
- drawables/shapes/polygon-factory
- drawables/shapes/rotated-rectangle-factory
- graphics/graphics-library/context-lost-exception
- graphics/graphics-library/frame-buffer/default-frame-buffer
- graphics/graphics-library/frame-buffer/frame-buffer
- graphics/graphics-library/frame-buffer/intermediate-frame-buffer
- graphics/graphics-library/helper/enable-context-lost-simulator
- graphics/graphics-library/helper/enable-extension
- graphics/graphics-library/helper/get-hardware-info
- graphics/graphics-library/helper/load-uniform
- graphics/graphics-library/helper/stopwatch
- graphics/graphics-library/parallel-compiler
- graphics/graphics-library/program/fragment-shader-only-program
- graphics/graphics-library/program/i-program
- graphics/graphics-library/program/program
- graphics/graphics-library/program/uniform-array-autoscaling-program
- graphics/graphics-library/texture/color-texture
- graphics/graphics-library/texture/distance-texture
- graphics/graphics-library/texture/palette-texture
- graphics/graphics-library/texture/texture
- graphics/graphics-library/texture/texture-options
- graphics/graphics-library/universal-rendering-context
- graphics/rendering/fps-quality-autoscaler
- graphics/rendering/render-pass/distance-render-pass
- graphics/rendering/render-pass/lights-render-pass
- graphics/rendering/render-pass/render-pass
- graphics/rendering/renderer/context-aware-renderer
- graphics/rendering/renderer/noise-renderer
- graphics/rendering/renderer/renderer
- graphics/rendering/renderer/renderer-implementation
- graphics/rendering/renderer/renderer-info
- graphics/rendering/settings/default-runtime-settings
- graphics/rendering/settings/default-startup-settings
- graphics/rendering/settings/runtime-settings
- graphics/rendering/settings/startup-settings
- graphics/rendering/uniforms-provider
- helper/array
- helper/clamp
- helper/code-for-color-access
- helper/color-to-string
- helper/colors/hex
- helper/colors/hsl
- helper/colors/rgb
- helper/colors/rgb255
- helper/colors/rgba
- helper/colors/rgba255
- helper/delta-time-calculator
- helper/exponential-decay
- helper/format-log
- helper/get-combinations
- helper/last
- helper/mix
- helper/ms-to-string
- helper/number-to-glsl-float
- helper/wait
- main
- run-animation
+
+
+
+
+ Namespace __global
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/modules/compile.html b/docs/modules/compile.html
deleted file mode 100644
index 6563a81..0000000
--- a/docs/modules/compile.html
+++ /dev/null
@@ -1 +0,0 @@
-
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Interfaces
+-
+
- Array +
- Float32
Array
+ - Readonly
Array
+
Module compile
Functions
Module drawables/drawable-descriptor
Interfaces
Module drawables/drawable
Classes
Module drawables/empty-drawable
Module drawables/lights/circle-light
Drawable
Module drawables/lights/flashlight
Drawable
Module drawables/lights/light-drawable
Module drawables/shapes/circle-factory
Drawable
Module drawables/shapes/colorful-circle
Classes
Module drawables/shapes/droplet-factory
Drawable
Module drawables/shapes/hexagon-factory
Drawable
Module drawables/shapes/inverted-tunnel-factory
Drawable
Module drawables/shapes/meta-circle-factory
Drawable
Module drawables/shapes/noisy-polygon-factory
Drawable
Module drawables/shapes/polygon-factory
Drawable
Module drawables/shapes/rotated-rectangle-factory
Drawable
Module graphics/graphics-library/context-lost-exception
Module graphics/graphics-library/frame-buffer/default-frame-buffer
Module graphics/graphics-library/frame-buffer/frame-buffer
Module graphics/graphics-library/frame-buffer/intermediate-frame-buffer
Module graphics/graphics-library/helper/enable-context-lost-simulator
Module graphics/graphics-library/helper/enable-extension
Module graphics/graphics-library/helper/get-hardware-info
Module graphics/graphics-library/helper/load-uniform
Module graphics/graphics-library/helper/stopwatch
Module graphics/graphics-library/parallel-compiler
Module graphics/graphics-library/program/fragment-shader-only-program
Module graphics/graphics-library/program/i-program
Module graphics/graphics-library/program/program
Module graphics/graphics-library/program/uniform-array-autoscaling-program
Module graphics/graphics-library/texture/color-texture
Module graphics/graphics-library/texture/distance-texture
Module graphics/graphics-library/texture/palette-texture
Module graphics/graphics-library/texture/texture-options
Enumerations
Interfaces
Type Aliases
Module graphics/graphics-library/texture/texture
Module graphics/graphics-library/universal-rendering-context
Module graphics/rendering/fps-quality-autoscaler
Classes
Module graphics/rendering/render-pass/distance-render-pass
Module graphics/rendering/render-pass/lights-render-pass
Module graphics/rendering/render-pass/render-pass
Module graphics/rendering/renderer/context-aware-renderer
Module graphics/rendering/renderer/noise-renderer
Functions
Module graphics/rendering/renderer/renderer-implementation
Module graphics/rendering/renderer/renderer-info
Interfaces
Module graphics/rendering/renderer/renderer
Interfaces
Module graphics/rendering/settings/default-runtime-settings
Variables
Module graphics/rendering/settings/default-startup-settings
Variables
Module graphics/rendering/settings/runtime-settings
Interfaces
Module graphics/rendering/settings/startup-settings
Interfaces
Module graphics/rendering/uniforms-provider
Module helper/array
Module helper/clamp
Module helper/code-for-color-access
Module helper/color-to-string
Module helper/colors/hex
Color
Module helper/colors/hsl
Color
Module helper/colors/rgb
Color
Module helper/colors/rgb255
Color
Module helper/colors/rgba
Color
Module helper/colors/rgba255
Color
Module helper/delta-time-calculator
Classes
Module helper/exponential-decay
Module helper/format-log
Module helper/get-combinations
Module helper/last
Module helper/mix
Module helper/ms-to-string
Module helper/number-to-glsl-float
Module helper/wait
Module main
Importing this file gives arrays (Array and Float32Array instances)
-two new properties: x and y. The former refers to their 0th element,
-and the latter to their 1st.
References
- CircleFactory → CircleFactory
- CircleLight → CircleLight
- ColorfulCircle → ColorfulCircle
- compile → compile
- DeltaTimeCalculator → DeltaTimeCalculator
- Drawable → Drawable
- DrawableDescriptor → DrawableDescriptor
- DropletFactory → DropletFactory
- FilteringOptions → FilteringOptions
- Flashlight → Flashlight
- hex → hex
- HexagonFactory → HexagonFactory
- hsl → hsl
- InvertedTunnelFactory → InvertedTunnelFactory
- MetaCircleFactory → MetaCircleFactory
- NoisyPolygonFactory → NoisyPolygonFactory
- PolygonBase → PolygonBase
- PolygonFactory → PolygonFactory
- Renderer → Renderer
- renderNoise → renderNoise
- rgb → rgb
- rgb255 → rgb255
- rgba → rgba
- rgba255 → rgba255
- RotatedRectangleFactory → RotatedRectangleFactory
- runAnimation → runAnimation
- TextureOptions → TextureOptions
- TextureWithOptions → TextureWithOptions
- WrapOptions → WrapOptions
Module run-animation
Functions
Variable defaultRuntimeSettingsConst
Contains the default values used for [[RuntimeSettings]].
-Variable defaultStartupSettingsConst
Contains the default values used for [[StartupSettings]].
-