diff --git a/doc/clog-manual.html b/doc/clog-manual.html index e4fb5b5..41f1a90 100644 --- a/doc/clog-manual.html +++ b/doc/clog-manual.html @@ -50,20 +50,21 @@
STATUS: CLOG is complete and all work is on higher order additions, -such as full desktop over the web, database tools,etc. See below for -some enhacements being worked on. CLOG is actually based on GNOGA, a -framework I wrote for Ada in 2013 and used in commercial production -code for the last 8+ years, i.e. the techniques CLOG uses are solid -and proven.
- -CLOG is being actively extended daily. Check the github discussion -boards for the latest.
+STATUS: CLOG's API is mature and stable. Tools and new plugins always in +the works. Check the github discussion boards for the latest.
Some potential applications for CLOG:
@@ -362,29 +356,38 @@ properties (to use for :property) are based on the event type.[function] INITIALIZE ON-NEW-WINDOW-HANDLER &KEY (HOST "0.0.0.0") (PORT 8080) (SERVER :HUNCHENTOOT) (EXTENDED-ROUTING NIL) (LONG-POLL-FIRST NIL) (BOOT-FILE "/boot.html") (BOOT-FUNCTION NIL) (STATIC-BOOT-HTML NIL) (STATIC-BOOT-JS NIL) (STATIC-ROOT (MERGE-PATHNAMES "./static-files/" (ASDF/SYSTEM:SYSTEM-SOURCE-DIRECTORY :CLOG)))
[function] INITIALIZE ON-NEW-WINDOW-HANDLER &REST REST &KEY (HOST "0.0.0.0") (PORT 8080) (SERVER :HUNCHENTOOT) (LACK-MIDDLEWARE-LIST NIL) (EXTENDED-ROUTING NIL) (LONG-POLL-FIRST NIL) (BOOT-FILE "/boot.html") (BOOT-FUNCTION NIL) (STATIC-BOOT-HTML NIL) (STATIC-BOOT-JS NIL) (STATIC-ROOT (MERGE-PATHNAMES "./static-files/" (ASDF/SYSTEM:SYSTEM-SOURCE-DIRECTORY :CLOG)))
Inititalize CLOG on a socket using HOST and PORT to serve BOOT-FILE
-as the default route to establish web-socket connections and static
-files located at STATIC-ROOT. The webserver used with CLACK can be
-chosed with :SERVER. If EXTENDED-ROUTING is t routes will match even
-if extend with additional / and additional paths. If
-LONG-POLLING-FIRST is t, the output is sent as HTML instead of
-websocket commands until on-new-window-handler ends, this should be
-used in webserver applications to enable crawling of your website. If
-CLOG was already initialized and not shut down, this function does the
-same as set-on-new-window (does not change the static-root). If
-ON-NEW-WINDOW-HANDLER is nil no handler is set and none is
-removed. STATIC-ROOT by default is the "directory CLOG is installed
-in ./static-files" If the variable clog:overide-static-root is set
-STATIC-ROOT will be ignored. If BOOT-FILE is nil no default boot-file
-will be set for root path, i.e. /. If static-boot-js is t then boot.js
-is served from the file /js/boot.js instead of the compiled
-version. If static-boot-html is nil if boot.html is not present will
-use compiled version. boot-function if set is called with the url and
-the contents of boot-file and its return value replaces the contents
-sent to the brower, this allows adding content for search engine
-optimization, see tutorial 12 for an example.
Inititalize CLOG on a socket using HOST and PORT to serve BOOT-FILE as the
+default route to establish web-socket connections and static files located at
+STATIC-ROOT. The webserver used with CLACK can be chosen with :SERVER and
+middlewares prepended with :LACK-MIDDLEWARE-LIST, NOT(0 1) supporting LACK.BUILDER DSL.
+If EXTENDED-ROUTING is t routes will match even if extend with additional / and
+additional paths. If LONG-POLLING-FIRST is t then long polling continues until
+the on-new-window-handler ends, if LONG-POLLING-FIRST is a number continues long
+polling until that number of queries to browser. LONG-POLLING-FIRST is used in
+webserver applications to enable crawling of your website. If CLOG was already
+initialized and not shut down, this function does the same as
+set-on-new-window (does not change the static-root). If ON-NEW-WINDOW-HANDLER is
+nil no handler is set and none is removed. STATIC-ROOT by default is the
+"directory CLOG is installed in ./static-files" If the variable
+clog:overide-static-root is set STATIC-ROOT will be ignored. If BOOT-FILE is
+nil no default boot-file will be set for root path, i.e. /. If static-boot-js is
+t then boot.js is served from the file /js/boot.js instead of the compiled
+version. If static-boot-html is nil if boot.html is not present will use
+compiled version. boot-function if set is called with the url and the contents
+of boot-file and its return value replaces the contents sent to the brower, this
+allows adding content for search engine optimization, see tutorial 12 for an
+example.
[variable] *STATIC-ROOT* NIL
+ +Contains the static-root setting after initialization.
@@ -687,6 +690,16 @@ lisp and an HTML DOM element.
CLOG-Obj - Low Level
+ + +[variable] *STORE-NEW-OBJECTS* NIL
+ +Dynamic variable that when true every create-* or attach-* will also +create a connection-data-item keyed by the html-id
[generic-function] SCRIPT-ID CLOG-OBJ
+ +Return the script id for OBJ based on the html-id set
+during attachment. (Private)
The special key per browser and platform is:
-Browser Windows Linux Mac
------------------ ------- ----- ---
-Internet Explorer [Alt] N/A N/A
-Chrome [Alt] [Alt] [Control][Alt]
-Firefox [Alt][Shift] [Alt][Shift] [Control][Alt]
-Safari [Alt] N/A [Control][Alt]
-Opera 15+ [Alt] [Alt] [Alt]
+Browser Windows Linux Mac
+----------------- ------- ----- ---
+Internet Explorer Alt N/A N/A
+Chrome Alt Alt Control|Alt
+Firefox Alt|Shift Alt|Shift Control|Alt
+Safari Alt N/A Control|Alt
+Opera 15+ Alt Alt Alt
@@ -1932,12 +1955,12 @@ flex - Turn this item in to a flexbox container. The flexbox
order - sets visual item order in flexbox
align-self - override flexbox's align-items for item
- :flex-start [--- ]
- :flex-end [ ---]
- :center [ --- ]
- :space-between [- - -]
- :space-around [ - - - ]
- :space-evenly [ - - - ]
+ :flex-start (--- )
+ :flex-end ( ---)
+ :center ( --- )
+ :space-between (- - -)
+ :space-around ( - - - )
+ :space-evenly ( - - - )
grid - Turn this item in to a grid container block level. The grid
properties to adjust for container are:
@@ -2611,7 +2634,7 @@ is relative to origin of: padding-box|border-box|content-box
[generic-function] BACKGROUND-REPEAT CLOG-ELEMENT
Get/Setf background-repeat. repeat-x | repeat-y |
- repeat | space | round | no-repeat {1,2}
+( repeat | space | round | no-repeat ) {1,2}
@@ -2927,6 +2950,40 @@ on browser.
simulate click.
+
+
+
+[generic-function] REPLACE-ELEMENT CLOG-ELEMENT NEW-CLOG-ELEMENT
+
+CLOG-ELEMENT and its children will we removed from DOM
+but not destroyed and NEW-CLOG-ELEMENT will replace it in same location.
+DESTROY CLOG-ELEMENT if need to clear from browser memory.
+Returns CLOG-ELEMENT
+
+
+
+
+
+[generic-function] REPLACE-CHILDREN CLOG-ELEMENT NEW-CLOG-ELEMENT
+
+All CLOG-ELEMENT's children will we removed from DOM
+but not destroyed and NEW-CLOG-ELEMENT will be placed in CLOG-ELEMENT.
+DESTROY CLOG-ELEMENT if need to clear from browser memory.
+Returns CLOG-ELEMENT
+
+
+
+
+
+[generic-function] SWAP-ELEMENT-BY-ID HTML-ID CLOG-ELEMENT
+
+Replace an existing element on page with HTML-ID with
+CLOG-ELEMENT and set CLOG-ELEMENT to html-id. Returns CLOG-ELEMENT
+
+
CLOG-Element - DOM Traversal Methods
@@ -4617,6 +4674,15 @@ if :HTML-ID "myid" then the HTML-ID for cent
Returns the bottom panel of a clog-panel-box-layout object.
+
+
+
+[generic-function] FIT-LAYOUT CLOG-PANEL-BOX-LAYOUT
+
+Recalculate layout based on size of outer panel content
+
+
@@ -5397,7 +5463,7 @@ optionally fill in with contents of data-list.
-
+
15 CLOG Canvas Objects
@@ -5438,124 +5504,164 @@ optionally fill in with contents of data-list.
Create a new CLOG-Context2d from a CLOG-Canvas
-
+CLOG-Canvas - Properties
+
+
-[generic-function] CLEAR-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
+[generic-function] FILL-STYLE CLOG-CONTEXT2D
-Clear rectangle to transparent black
+Setf/get property fill style
-
+
-[generic-function] FILL-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
+[generic-function] CANVAS-FILTER CLOG-CONTEXT2D
-Fill rectangle with current fill-color
-
-
-
-
-
-[generic-function] STROKE-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
-
-Fill rectangle using current stroke-style
-
-
-
-
-
-[generic-function] FILL-TEXT CLOG-CONTEXT2D TEXT X Y &KEY MAX-WIDTH
-
-Fill text with current fill-color
-
-
-
-
-
-[generic-function] STROKE-TEXT CLOG-CONTEXT2D TEXT X Y &KEY MAX-WIDTH
-
-Stroke text with current stroke-style
-
-
-
-
-
-[generic-function] LINE-WIDTH CLOG-CONTEXT2D VALUE
-
-Set line style width
-
-
-
-
-
-[generic-function] LINE-CAP CLOG-CONTEXT2D VALUE
-
-Set line cap style
-
-
-
-
-
-[generic-function] LINE-JOIN CLOG-CONTEXT2D VALUE
-
-Set line join style
-
-
-
-
-
-[generic-function] MITER-LIMIT CLOG-CONTEXT2D VALUE
-
-Set miter style limit
-
-
-
-
-
-[generic-function] GET-LINE-DASH CLOG-CONTEXT2D
-
-Set line style dash pattern, e.g. 10, 20
-
-
-
-
-
-[generic-function] SET-LINE-DASH CLOG-CONTEXT2D VALUE
-
-Set line style dash pattern, e.g. 10, 20
-
-
-
-
-
-[generic-function] LINE-DASH-OFFSET CLOG-CONTEXT2D VALUE
-
-Set miter style limit
+Setf/get filter dsl -
+See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/filter
-[generic-function] FONT-STYLE CLOG-CONTEXT2D VALUE
+[generic-function] FONT-STYLE CLOG-CONTEXT2D
-Set font style using css font string
+
Setf/get font using css font string
https://developer.mozilla.org/en-US/docs/Web/CSS/font
+
+
+
+[generic-function] GLOBAL-ALPHA CLOG-CONTEXT2D
+
+Setf/get global alpha
+
+
+
+
+
+[generic-function] GLOBAL-COMPOSITE-OPERATION CLOG-CONTEXT2D
+
+Setf/get composite blend mode -
+https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation
+
+
+
+
+
+[generic-function] IMAGE-SMOOTHING-ENABLED CLOG-CONTEXT2D
+
+Setf/get text shadow blur
+
+
+
+
+
+[generic-function] IMAGE-SMOOTHING-QUALITY CLOG-CONTEXT2D
+
+Setf/get text shadow blur
+
+
+
+
+
+[generic-function] LINE-CAP CLOG-CONTEXT2D
+
+Setf/get line cap style
+
+
+
+
+
+[generic-function] LINE-DASH-OFFSET CLOG-CONTEXT2D
+
+Setf/get miter style limit
+
+
+
+
+
+[generic-function] LINE-JOIN CLOG-CONTEXT2D
+
+Setf/get line join style
+
+
+
+
+
+[generic-function] LINE-WIDTH CLOG-CONTEXT2D
+
+Set line style width
+
+
+
+
+
+[generic-function] MITER-LIMIT CLOG-CONTEXT2D
+
+Setf/get miter style limit
+
+
+
+
+
+[generic-function] SHADOW-BLUR CLOG-CONTEXT2D
+
+Setf/get text shadow blur
+
+
+
+
+
+[generic-function] SHADOW-COLOR CLOG-CONTEXT2D
+
+Setf/get text shadow color
+
+
+
+
+
+[generic-function] SHADOW-OFFSET-X CLOG-CONTEXT2D
+
+Setf/get text shadow offset x
+
+
+
+
+
+[generic-function] SHADOW-OFFSET-Y CLOG-CONTEXT2D
+
+Setf/get text shadow offset y
+
+
+
+
+
+[generic-function] STROKE-STYLE CLOG-CONTEXT2D
+
+Setf/get text stroke style
+
+
@@ -5567,9 +5673,9 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
-[generic-function] TEXT-ALIGN CLOG-CONTEXT2D VALUE
+[generic-function] TEXT-ALIGN CLOG-CONTEXT2D
-Set text alignment style
+Setf/get text alignment style
@@ -5583,7 +5689,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
-[generic-function] TEXT-BASELINE CLOG-CONTEXT2D VALUE
+[generic-function] TEXT-BASELINE CLOG-CONTEXT2D
Set text baseline style
@@ -5592,118 +5698,12 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
-[generic-function] TEXT-DIR CLOG-CONTEXT2D VALUE
+[generic-function] TEXT-DIR CLOG-CONTEXT2D
-Set text direction style
+Setf/get text direction style
-
-
-
-[generic-function] FILL-STYLE CLOG-CONTEXT2D VALUE
-
-Set text direction style
-
-
-
-
-
-[generic-function] STROKE-STYLE CLOG-CONTEXT2D VALUE
-
-Set text stroke style
-
-
-
-
-
-[generic-function] SHADOW-BLUR CLOG-CONTEXT2D VALUE
-
-Set text shadow blur
-
-
-
-
-
-[generic-function] SHADOW-COLOR CLOG-CONTEXT2D VALUE
-
-Set text shadow color
-
-
-
-
-
-[generic-function] SHADOW-OFFSET-X CLOG-CONTEXT2D VALUE
-
-Set text shadow offset x
-
-
-
-
-
-[generic-function] SHADOW-OFFSET-Y CLOG-CONTEXT2D VALUE
-
-Set text shadow offset y
-
-
-
-
-
-[generic-function] BEGIN-PATH CLOG-CONTEXT2D
-
-Starts a new path empting any previous points.
-
-
-
-
-
-[generic-function] CLOSE-PATH CLOG-CONTEXT2D
-
-Adds a line to start point of path.
-
-
-
-
-
-[generic-function] MOVE-TO CLOG-CONTEXT2D X Y
-
-Moves start point of path.
-
-
-
-
-
-[generic-function] LINE-TO CLOG-CONTEXT2D X Y
-
-Adds a line to the current path.
-
-
-
-
-
-[generic-function] BEZIER-CURVE-TO CLOG-CONTEXT2D CP1X CP1Y CP2X CP2Y X Y
-
-Adds a cubic Bezier curve to the current path.
-
-
-
-
-
-[generic-function] QUADRATIC-CURVE-TO CLOG-CONTEXT2D CPX CPY X Y
-
-Adds a quadratic Bezier curve to the current path.
-
+CLOG-Canvas - Methods
@@ -5723,6 +5723,114 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
Adds an arc to the current path.
+
+
+
+[generic-function] BEGIN-PATH CLOG-CONTEXT2D
+
+Starts a new path empting any previous points.
+
+
+
+
+
+[generic-function] BEZIER-CURVE-TO CLOG-CONTEXT2D CP1X CP1Y CP2X CP2Y X Y
+
+Adds a cubic Bezier curve to the current path.
+
+
+
+
+
+[generic-function] CLEAR-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
+
+Clear rectangle to transparent black
+
+
+
+
+
+[generic-function] PATH-CLIP CLOG-CONTEXT2D &KEY PATH2D FILL-RULE
+
+Clip a path.
+
+
+
+
+
+[generic-function] CLOSE-PATH CLOG-CONTEXT2D
+
+Adds a line to start point of path.
+
+
+
+
+
+[generic-function] CREATE-IMAGE-DATA CLOG-CONTEXT2D WIDTH HEIGHT
+
+Create black image data
+
+
+
+
+
+[generic-function] CREATE-CONIC-GRADIENT CLOG-CONTEXT2D START-ANGLE X Y
+
+Create conic gradient
+
+
+
+
+
+[generic-function] CREATE-LINEAR-GRADIENT CLOG-CONTEXT2D X0 Y0 X1 Y1
+
+Create linear gradient
+
+
+
+
+
+[generic-function] CREATE-RADIAL-GRADIENT CLOG-CONTEXT2D X0 Y0 R0 X1 Y1 R1
+
+Create radial gradient
+
+
+
+
+
+[generic-function] CREATE-PATTERN CLOG-CONTEXT2D CLOG-OBJ REPETITION
+
+Create pattern
+
+
+
+
+
+[generic-function] DRAW-IMAGE CLOG-CONTEXT2D CLOG-OBJ DX DY &KEY DWIDTH DHEIGHT
+
+Draw image at dx dy optionally dwidth and dheight
+
+
+
+
+
+[generic-function] DRAW-IMAGE-FROM-TO CLOG-CONTEXT2D CLOG-OBJ SX SY SWIDTH SHEIGHT DX DY DWIDTH DHEIGHT
+
+Draw image at sx sy swidth sheight to dx dy dwidth dheight
+
+
@@ -5732,6 +5840,132 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
Adds an elliptical arc to the current path.
+
+
+
+[generic-function] PATH-FILL CLOG-CONTEXT2D &KEY PATH2D FILL-RULE
+
+Fill a path.
+
+
+
+
+
+[generic-function] FILL-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
+
+Fill rectangle with current fill-color
+
+
+
+
+
+[generic-function] FILL-TEXT CLOG-CONTEXT2D TEXT X Y &KEY MAX-WIDTH
+
+Fill text with current fill-color
+
+
+
+
+
+[generic-function] GET-IMAGE-DATA CLOG-CONTEXT2D SX SY SW SH
+
+Get image data from clog-context2d. Returns a CLOG-IMAGE-DATA
+
+
+
+
+
+[generic-function] GET-LINE-DASH CLOG-CONTEXT2D
+
+Set line style dash pattern, e.g. 10, 20
+
+
+
+
+
+[generic-function] GET-TRANSFORM CLOG-CONTEXT2D
+
+Get current transform matrix as clog-matrix
+
+
+
+
+
+[generic-function] IS-POINT-IN-PATH CLOG-CONTEXT2D X Y &KEY PATH2D FILL-RULE
+
+Returns t if point is in path or PATH2D if specfified
+
+
+
+
+
+[generic-function] IS-POINT-IN-STROKE CLOG-CONTEXT2D X Y &KEY PATH2D
+
+Returns t if point is in stroke or PATH2D if specfified
+
+
+
+
+
+[generic-function] LINE-TO CLOG-CONTEXT2D X Y
+
+Adds a line to the current path.
+
+
+
+
+
+[generic-function] MEASURE-TEXT CLOG-CONTEXT2D TEXT
+
+Measure text returns a clog-text-metrics object
+
+
+
+
+
+[generic-function] MOVE-TO CLOG-CONTEXT2D X Y
+
+Moves start point of path.
+
+
+
+
+
+[generic-function] PUT-IMAGE-DATA CLOG-CONTEXT2D IMAGE-DATA X Y
+
+Put image-data at x y
+
+
+
+
+
+[generic-function] PUT-IMAGE-DATA-DIRTY CLOG-CONTEXT2D IMAGE-DATA X Y DX DY DWIDTH DHEIGHT
+
+Put portion of image-data at x y
+
+
+
+
+
+[generic-function] QUADRATIC-CURVE-TO CLOG-CONTEXT2D CPX CPY X Y
+
+Adds a quadratic Bezier curve to the current path.
+
+
@@ -5741,40 +5975,13 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
Adds a rectangle to the current path.
-
+
-[generic-function] PATH-FILL CLOG-CONTEXT2D
+[generic-function] RESET-TRANSFORM CLOG-CONTEXT2D
-Fill a path.
-
-
-
-
-
-[generic-function] PATH-STROKE CLOG-CONTEXT2D
-
-Stroke a path.
-
-
-
-
-
-[generic-function] PATH-CLIP CLOG-CONTEXT2D
-
-Clip a path.
-
-
-
-
-
-[generic-function] CANVAS-SAVE CLOG-CONTEXT2D
-
-Save canvas to stack
+Restore canvas from stack
@@ -5786,12 +5993,1617 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/font
Restore canvas from stack
+
+
+
+[generic-function] ROTATE CLOG-MATRIX ANGLE
+
+Return rotate a clog-matrix
+
+
+
+
+
+[generic-function] CANVAS-SAVE CLOG-CONTEXT2D
+
+Save canvas to stack
+
+
+
+
+
+[generic-function] SCALE CLOG-CONTEXT2D X Y
+
+Scale
+
+
+
+
+
+[generic-function] SET-LINE-DASH CLOG-CONTEXT2D VALUE
+
+Set line style dash pattern, e.g. 10, 20
+
+
+
+
+
+[generic-function] SET-TRANSFORM CLOG-CONTEXT2D A B C D E F G
+
+Set-Transform
+
+
+
+
+
+[generic-function] SET-TRANSFORM-WITH-MATRIX CLOG-CONTEXT2D CLOG-MATRIX
+
+Set-Transform-With-Matrix
+
+
+
+
+
+[generic-function] PATH-STROKE CLOG-CONTEXT2D &KEY PATH2D
+
+Stroke a path.
+
+
+
+
+
+[generic-function] STROKE-RECT CLOG-CONTEXT2D X Y WIDTH HEIGHT
+
+Fill rectangle using current stroke-style
+
+
+
+
+
+[generic-function] STROKE-TEXT CLOG-CONTEXT2D TEXT X Y &KEY MAX-WIDTH
+
+Stroke text with current stroke-style
+
+
+
+
+
+[generic-function] TRANSFORM CLOG-CONTEXT2D A B C D E F
+
+Transform
+
+
+
+
+
+[generic-function] TRANSLATE CLOG-CONTEXT2D X Y
+
+Translate
+
+
+CLOG-Canvas-Gradient
+
+
+
+
+- [class] CLOG-CANVAS-GRADIENT CLOG-OBJ
+
+
+
+
+
+[generic-function] ADD-COLOR-STOP CLOG-CANVAS-GRADIENT OFFSET COLOR
+
+Add a color stop
+
+
+CLOG-Image-Data
+
+
+
+
+- [class] CLOG-IMAGE-DATA CLOG-OBJ
+
+
+
+
+
+[generic-function] JSON-IMAGE-DATA CLOG-IMAGE-DATA
+
+Setf/get json image data
+
+
+CLOG-Matrix
+
+
+
+
+- [class] CLOG-MATRIX CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-MATRIX CLOG-CANVAS &KEY MATRIX
+
+Create a new CLOG-Matrix. MATRIX can be
+json array 6 element for 2d or 16 for 3d.
+
+
+
+
+
+[generic-function] FLIP-X CLOG-MATRIX
+
+Return flip-x a clog-matrix
+
+
+
+
+
+[generic-function] FLIP-Y CLOG-MATRIX
+
+Return flip-y a clog-matrix
+
+
+
+
+
+[generic-function] INVERSE CLOG-MATRIX
+
+Return inverse a clog-matrix
+
+
+
+
+
+[generic-function] MULTIPLY CLOG-MATRIX BY-MATRIX
+
+Return multiply a clog-matrix
+
+
+
+
+
+[generic-function] ROTATE CLOG-MATRIX ANGLE
+
+Return rotate a clog-matrix
+
+
+
+
+
+[generic-function] SCALE-MATRIX CLOG-MATRIX SX &OPTIONAL SY SZ OX OY OZ
+
+Return scale a clog-matrix by sx and optionally to
+sy sz ox oy oz
+
+
+
+
+
+[generic-function] SCALE3D CLOG-MATRIX SX &OPTIONAL SY SZ OX OY OZ
+
+Return scale3d a clog-matrix by sx and optionally to
+sy sz ox oy oz
+
+
+
+
+
+[generic-function] TRANSLATE-MATRIX CLOG-MATRIX X Y &OPTIONAL Z
+
+Return translate-matrix a clog-matrix by x y and optionally z
+
+
+CLOG-Path2d
+
+
+
+
+- [class] CLOG-PATH2D CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-PATH2D CLOG-CANVAS &KEY PATH2D
+
+Create a new CLOG-Path2d. If CLOG-PATH2D creates a copy.
+
+
+CLOG-Text-Metrics
+
+
+
+
+- [class] CLOG-TEXT-METRICS CLOG-OBJ
+
+
+
+
+
+[generic-function] ACTUAL-BOUNDING-BOX-LEFT CLOG-TEXT-METRICS
+
+Actual bounding box left
+
+
+
+
+
+[generic-function] ACTUAL-BOUNDING-BOX-RIGHT CLOG-TEXT-METRICS
+
+Actual bounding box right
+
+
+
+
+
+[generic-function] ACTUAL-BOUNDING-BOX-ASCENT CLOG-TEXT-METRICS
+
+Actual bounding box ascent
+
+
+
+
+
+[generic-function] ACTUAL-BOUNDING-BOX-DESCENT CLOG-TEXT-METRICS
+
+Actual bounding box descent
+
+
+
+
+
+[generic-function] FONT-BOUNDING-BOX-ASCENT CLOG-TEXT-METRICS
+
+Font bounding box ascent
+
+
+
+
+
+[generic-function] FONT-BOUNDING-BOX-DESCENT CLOG-TEXT-METRICS
+
+Font bounding box descent
+
+
+
+
+
+[generic-function] EM-HEIGHT-ASCENT CLOG-TEXT-METRICS
+
+'M' height ascent
+
+
+
+
+
+[generic-function] EM-HEIGHT-DESCENT CLOG-TEXT-METRICS
+
+'M' height descent
+
+
+
+
+
+[generic-function] HANGING-BASELINE CLOG-TEXT-METRICS
+
+Hanging baseline
+
+
+
+
+
+[generic-function] ALPHABETIC-BASELINE CLOG-TEXT-METRICS
+
+Alphabetic baseline
+
+
+
+
+
+[generic-function] IDEOGRAPHIC-BASELINE CLOG-TEXT-METRICS
+
+Ideographic baseline
+
+
+
+
+
+
+16 CLOG WebGL Objects
+
+[in package CLOG-WEBGL]
+
+CLOG-WebGL - Class for CLOG WebGL objects
+
+
+
+
+- [class] CLOG-WEBGL CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-WEBGL CLOG-CANVAS &KEY CONTEXT
+
+Create a new CLOG-WebGL from a CLOG-Canvas. Context
+can be webgl (version 1) or webgl2 (default)
+
+
+
+
+
+[generic-function] DRAWING-BUFFER-WIDTH CLOG-WEBGL
+
+Drawing are of buffer width. returns float
+
+
+
+
+
+[generic-function] DRAWING-BUFFER-HEIGHT CLOG-WEBGL
+
+Drawing are of buffer height. returns float
+
+
+
+
+
+[generic-function] BUFFER-PARAMETER CLOG-WEBGL GLENUM-TARGET GLENUM-PNAME
+
+Returns information about the buffer.
+target:
+A GLenum specifying the target buffer object. Possible values:
+
+:ARRAY_BUFFER
+Buffer containing vertex attributes, such as vertex coordinates, texture coordinate data, or vertex color data.
+
+:ELEMENT_ARRAY_BUFFER
+Buffer used for element indices.
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:COPY_READ_BUFFER
+Buffer for copying from one buffer object to another.
+
+:COPY_WRITE_BUFFER
+Buffer for copying from one buffer object to another.
+
+:TRANSFORM_FEEDBACK_BUFFER
+Buffer for transform feedback operations.
+
+:UNIFORM_BUFFER
+Buffer used for storing uniform blocks.
+
+:PIXEL_PACK_BUFFER
+Buffer used for pixel transfer operations.
+
+:PIXEL_UNPACK_BUFFER
+Buffer used for pixel transfer operations.
+
+pname:
+A GLenum specifying information to query. Possible values:
+
+:BUFFER_SIZE
+Returns a GLint indicating the size of the buffer in bytes.
+
+:BUFFER_USAGE
+Returns a GLenum indicating the usage pattern of the buffer. One of the followings:
+
+:STATIC_DRAW
+:DYNAMIC_DRAW
+:STREAM_DRAW
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:STATIC_READ
+:DYNAMIC_READ
+:STREAM_READ
+:STATIC_COPY
+:DYNAMIC_COPY
+:STREAM_COPY
+
+
+
+
+
+- [generic-function] CONTEXT-ATTRIBUTES OBJ
+
+
+
+
+
+- [generic-function] WEBGL-ERROR OBJ
+
+
+
+
+
+- [generic-function] FRAME-BUFFER-ATTACHMENT-PARAMETER OBJ GLENUM-TARGET GLENUM-ATTACHMENT GLENUM-PNAME
+
+
+
+
+
+- [generic-function] PARAMETER OBJ GLENUM-PNAME
+
+
+
+
+
+- [generic-function] RENDER-BUFFER-PARAMETER OBJ GLENUM-TARGET GLENUM-PNAME
+
+
+
+
+
+- [generic-function] TEXTURE-PARAMETER OBJ GLENUM-TARGET GLENUM-PNAME
+
+
+
+
+
+[generic-function] VERTEX-ATTRIBUTE CLOG-WEBGL INDEX GLENUM-PNAME
+
+Information about a vertex attribute at a given position.
+pname:
+A GLenum specifying the information to query. Possible values:
+
+:VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
+Returns the currently bound WebGLBuffer.
+
+:VERTEX_ATTRIB_ARRAY_ENABLED
+Returns a GLboolean that is true if the vertex attribute is enabled at this index. Otherwise false.
+
+:VERTEX_ATTRIB_ARRAY_SIZE
+Returns a GLint indicating the size of an element of the vertex array.
+
+:VERTEX_ATTRIB_ARRAY_STRIDE
+Returns a GLint indicating the number of bytes between successive elements in the array. 0 means that the elements are sequential.
+
+:VERTEX_ATTRIB_ARRAY_TYPE
+Returns a GLenum representing the array type. One of
+
+:BYTE
+:UNSIGNED_BYTE
+:SHORT,
+:UNSIGNED_SHORT
+:FLOAT
+:VERTEX_ATTRIB_ARRAY_NORMALIZED
+Returns a GLboolean that is true if fixed-point data types are normalized for the vertex attribute array at the given index.
+
+:CURRENT_VERTEX_ATTRIB
+Returns a Float32Array (with 4 elements) representing the current value of the vertex attribute at the given index.
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:VERTEX_ATTRIB_ARRAY_INTEGER
+Returns a GLboolean indicating whether an integer data type is in the vertex attribute array at the given index.
+
+:VERTEX_ATTRIB_ARRAY_DIVISOR
+Returns a GLint describing the frequency divisor used for instanced rendering.
+
+
+
+
+
+[generic-function] ACTIVE-TEXTURE CLOG-WEBGL GLENUM-TEXTURE
+
+Sets the active textcture in gl context based on :TEXTUREI
+where I is the texture number.
+
+
+
+
+
+[generic-function] BLEND-COLOR CLOG-WEBGL RED GREEN BLUE ALPHA
+
+Used to set the source and destination blending factors.
+
+
+
+
+
+[generic-function] BLEND-EQUATION CLOG-WEBGL GLENUM-MODE
+
+Used to set both the RGB blend equation and alpha blend equation to a single equation.
+:FUNC_ADD : source + destination (default value)
+:FUNC_SUBTRACT : source - destination
+:FUNC_REVERSE_SUBTRACT : destination - source
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:MIN : Minimum of source and destination
+:MAX : Maximum of source and destination
+
+
+
+
+
+[generic-function] BLEND-EQUATION-SEPERATE CLOG-WEBGL GLENUM-MODE-RGB GLENUM-MODE-ALPHA
+
+Used to set both the RGB blend equation and alpha blend equation to a single equation.
+:FUNC_ADD : source + destination (default value)
+:FUNC_SUBTRACT : source - destination
+:FUNC_REVERSE_SUBTRACT : destination - source
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:MIN : Minimum of source and destination
+:MAX : Maximum of source and destination
+
+
+
+
+
+[generic-function] BLEND-FUNCTION CLOG-WEBGL GLENUM-SOURCE-FACTOR GLENUM-DESTINATION-FACTOR
+
+Defines which function is used for blending pixel arithmetic.
+See - https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/blendFunc
+
+
+
+
+
+[generic-function] BLEND-FUNCTION-SEPERATE CLOG-WEBGL GLENUM-SOURCE-FACTOR-RGB GLENUM-DESTINATION-FACTOR-RGB GLENUM-SOURCE-FACTOR-ALPHA GLENUM-DESTINATION-FACTOR-ALPHA
+
+Defines which function is used for blending pixel arithmetic.
+See - https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/blendFunc
+
+
+
+
+
+[generic-function] CHECK-FRAME-BUFFER-STATUS CLOG-WEBGL TARGET
+
+Completeness status of frame buffer. Target can be:
+:FRAMEBUFFER
+Collection buffer data storage of color, alpha, depth and stencil buffers used to render an image.
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:DRAW_FRAMEBUFFER
+Equivalent to :FRAMEBUFFER. Used as a destination for drawing, rendering, clearing, and writing operations.
+
+:READ_FRAMEBUFFER
+Used as a source for reading operations.
+
+
+
+
+
+[generic-function] CLEAR-COLOR CLOG-WEBGL RED GREEN BLUE ALPHA
+
+Specifies the color values used when clearing color buffers
+with CLEAR-WEBGL.
+
+
+
+
+
+[generic-function] CLEAR-DEPTH CLOG-WEBGL DEPTH
+
+Specifying the depth value used when the depth buffer is cleared.
+
+
+
+
+
+[generic-function] CLEAR-WEBGL CLOG-WEBGL GLENUM-MASK
+
+Clears buffers to preset values. GLENUM-MASK can be:
+:COLOR_BUFFER_BIT
+:DEPTH_BUFFER_BIT
+:STENCIL_BUFFER_BIT
+
+
+
+
+
+[generic-function] CLEAR-STENCIL CLOG-WEBGL STENCIL
+
+Specifying the stencil index used when the stencil buffer is cleared.
+
+
+
+
+
+[generic-function] COLOR-MASK CLOG-WEBGL RED GREEN BLUE ALPHA
+
+Sets which color components to enable or to disable when drawing or rendering
+red green blue alpha are nil or true
+
+
+
+
+
+[generic-function] DEPTH-FUNCTION CLOG-WEBGL GLENUM-FUNC
+
+Specifies a function that compares incoming pixel depth to
+the current depth buffer value. GLENUM-FUNC can be:
+:NEVER (never pass)
+:LESS (pass if the incoming value is less than the depth buffer value)
+:EQUAL (pass if the incoming value equals the depth buffer value)
+:LEQUAL (pass if the incoming value is less than or equal to the depth buffer value)
+:GREATER (pass if the incoming value is greater than the depth buffer value)
+:NOTEQUAL (pass if the incoming value is not equal to the depth buffer value)
+:GEQUAL (pass if the incoming value is greater than or equal to the depth buffer value)
+:ALWAYS (always pass)
+
+
+
+
+
+[generic-function] DEPTH-MASK CLOG-WEBGL ENABLEP
+
+Specifying whether or not writing into the depth buffer is
+enabled
+
+
+
+
+
+[generic-function] DEPTH-RANGE CLOG-WEBGL ZNEAR ZFAR
+
+Specifies the depth range mapping from normalized device
+coordinates to window or viewport coordinates.
+
+
+
+
+
+[generic-function] DISABLE-CAPABILITY CLOG-WEBGL GLENUM-CAPABILITY
+
+Disables specific WebGL capabilities for this context.
+For GLENUM-CAPABILITY see:
+https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/disable
+
+
+
+
+
+[generic-function] DISABLE-VERTEX-ATTRIBUTE-ARRAY CLOG-WEBGL ATTRIBUTE-LOCATION
+
+Turns the generic vertex attribute array off at a given index
+position.
+
+
+
+
+
+[generic-function] DRAW-ARRAYS CLOG-WEBGL MODE OFFSET COUNT
+
+Renders primitives from array data. MODE can be:
+:POINTS Draws a single dot.
+:LINE_STRIP Draws a straight line to the next vertex.
+:LINE_LOOP Draws a straight line to the next vertex, and connects the last vertex back to the first.
+:LINES Draws a line between a pair of vertices.
+:TRIANGLE_STRIP
+:TRIANGLE_FAN
+:TRIANGLES Draws a triangle for a group of three vertices.
+
+
+
+
+
+[generic-function] DRAW-ELEMENTS CLOG-WEBGL MODE COUNT TYPE OFFSET
+
+Renders primitives from array data.
+MODE can be:
+:POINTS Draws a single dot.
+:LINE_STRIP Draws a straight line to the next vertex.
+:LINE_LOOP Draws a straight line to the next vertex, and connects the last vertex back to the first.
+:LINES Draws a line between a pair of vertices.
+:TRIANGLE_STRIP
+:TRIANGLE_FAN
+:TRIANGLES Draws a triangle for a group of three vertices.
+
+TYPE can be:
+:UNSIGNED_BYTE
+:UNSIGNED_SHORT
+
+
+
+
+
+[generic-function] ENABLE-CAPABILITY CLOG-WEBGL GLENUM-CAPABILITY
+
+Enables specific WebGL capabilities for this context.
+For GLENUM-CAPABILITY see:
+https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/enable
+
+
+
+
+
+[generic-function] ENABLE-VERTEX-ATTRIBUTE-ARRAY CLOG-WEBGL ATTRIBUTE-LOCATION
+
+Turns the generic vertex attribute array on at a given index
+position.
+
+
+
+
+
+[generic-function] FINISH CLOG-WEBGL
+
+Blocks execution until all previously called commands are
+finished. this needs to be written to fire an event when done to work fully
+with CLOG
+
+
+
+
+
+[generic-function] FLUSH CLOG-WEBGL
+
+Empties different buffer commands, causing all commands to
+be executed as quickly as possible
+
+
+
+
+
+[generic-function] FRAME-BUFFER-RENDER-BUFFER CLOG-WEBGL TARGET ATTACHMENT RENDERBUFFERTARGET CLOG-WEBGL-RENDER-BUFFER
+
+Attaches a clog-Render-buffer object to a clog-frame-buffer object
+
+
+
+
+
+[generic-function] FRAME-BUFFER-TEXTURE-2D CLOG-WEBGL TARGET ATTACHMENT TEXTARGET CLOG-FRAME-BUFFER LEVEL
+
+attaches a texture to a clog-frame-buffer
+
+
+
+
+
+[generic-function] FRONT-FACE CLOG-WEBGL GLENUM-MODE
+
+Specifies whether polygons are front- or back-facing by
+setting a winding orientation. GLENUM-MODE can be:
+:CW Clock-wise winding.
+:CCW Counter-clock-wise winding.
+
+
+
+
+
+[generic-function] GENERATE-MIPMAP CLOG-WEBGL GLENUM-TARGET
+
+Generates a set of mipmaps for a WebGLTexture object.
+GLENUM-TARGET can be:
+:TEXTURE_2D A two-dimensional texture.
+:TEXTURE_CUBE_MAP A cube-mapped texture.
+When using a WebGL 2 context, the following values are available additionally:
+
+:TEXTURE_3D A three-dimensional texture.
+:TEXTURE_2D_ARRAY A two-dimensional array texture
+
+
+
+
+
+[generic-function] HINT CLOG-WEBGL GLENUM-TARGET GLENUM-MODE
+
+Hints for certain behaviors. The interpretation of these
+hints depend on the implementation.
+
+target:
+Sets which behavior to be controlled. Possible values:
+
+:GENERATE_MIPMAP_HINT
+Quality of filtering when generating mipmap images with WebGLRenderingContext.generateMipmap().
+
+When using the OES_standard_derivatives extension:
+
+ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES
+Accuracy of the derivative calculation for the GLSL built-in functions: dFdx, dFdy, and fwidth.
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:FRAGMENT_SHADER_DERIVATIVE_HINT
+Same as ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES
+
+mode:
+Sets the behavior. The default value is :DONT_CARE. The possible values are:
+
+:FASTEST : The most efficient behavior should be used.
+:NICEST : The most correct or the highest quality option should be used.
+:DONT_CARE : There is no preference for this behavior.
+
+
+
+
+
+[generic-function] IS-CAPABILITY-ENABLED CLOG-WEBGL GLENUM-CAPABILITY
+
+Return true if glenum-capability is enabled.
+https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/isEnabled
+
+
+
+
+
+[generic-function] IS-CONTEXT-LOST CLOG-WEBGL
+
+Return true if context was lost and needs to be re-established
+
+
+
+
+
+- [generic-function] PIXEL-STORE-INTEGER OBJ GLENUM-PNAME VALUE
+
+
+
+
+
+- [generic-function] POLYGON-OFFSET OBJ FACTOR UNITS
+
+
+
+
+
+- [generic-function] RENDER-BUFFER-STORAGE OBJ GLENUM-TARGET GLENUM-INTERNAL-FORMAT WIDTH HEIGHT
+
+
+
+
+
+- [generic-function] SAMPLE-COVERAGE OBJ VALUE INVERTP
+
+
+
+
+
+- [generic-function] SCISSOR OBJ X Y WIDTH HEIGHT
+
+
+
+
+
+- [generic-function] STENCIL-FUNCTION OBJ GLENUM-FUNC REF MASK
+
+
+
+
+
+- [generic-function] STENCIL-FUNCTION-SEPERATE OBJ GLENUM-FACE GLENUM-FUNC REF MASK
+
+
+
+
+
+- [generic-function] STENCIL-MASK OBJ MASK
+
+
+
+
+
+- [generic-function] STENCIL-MASK-SEPERATE OBJ GLENUM-FACE MASK
+
+
+
+
+
+- [generic-function] STENCIL-OPERATION OBJ FAIL ZFAIL ZPASS
+
+
+
+
+
+- [generic-function] STENCIL-OPERATION-SEPERATE OBJ GLENUM-FACE FAIL ZFAIL ZPASS
+
+
+
+
+
+- [generic-function] TEXTURE-PARAMETER-FLOAT OBJ GLENUM-TARGET GLENUM-PNAME VALUE
+
+
+
+
+
+- [generic-function] TEXTURE-PARAMETER-INTEGER OBJ GLENUM-TARGET GLENUM-PNAME VALUE
+
+
+
+
+
+- [generic-function] UNIFORM-MATRIX OBJ SIZE LOCATION NORMALIZE MATRIX
+
+
+
+
+
+- [generic-function] VIEWPORT OBJ X Y WIDTH HEIGHT
+
+
+
+
+
+- [generic-function] VERTEX-ATTRIBUTE-POINTER OBJ ATTRIBUTE-LOCATION SIZE TYPE NORMALIZE STRIDE OFFSET
+
+
+
+
+
+- [generic-function] COMPILE-SHADER-SOURCE OBJ GLENUM-TYPE SOURCE
+
+
+
+
+
+- [generic-function] COMPILE-WEBGL-PROGRAM OBJ VERTEX-SHADER FRAGMENT-SHADER
+
+
+
+
+
+- [class] CLOG-WEBGL-UNIFORM CLOG-OBJ
+
+
+CLOG-WebGL-Active-Info - Class for CLOG WebGL Active Info objects
+
+
+
+
+- [class] CLOG-WEBGL-ACTIVE-INFO CLOG-OBJ
+
+
+
+
+
+[generic-function] INFO-NAME CLOG-WEBGL-ACTIVE-INFO
+
+Active Info Name
+
+
+
+
+
+[generic-function] INFO-SIZE CLOG-WEBGL-ACTIVE-INFO
+
+Active Info Size
+
+
+
+
+
+[generic-function] INFO-TYPE CLOG-WEBGL-ACTIVE-INFO
+
+Active Info Type
+
+
+CLOG-WebGL-Shader - Class for CLOG WebGL-Shader objects
+
+
+
+
+- [class] CLOG-WEBGL-SHADER CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-SHADER CLOG-WEBGL GLENUM-TYPE
+
+Create a clog-webgl-shader for type :GLENUM.
+See https://github.com/KhronosGroup/WebGL/blob/main/specs/latest/2.0/webgl2.idl
+For :GLENUM values
+
+
+
+
+
+[generic-function] IS-SHADER CLOG-WEBGL-SHADER
+
+Return true if is valid
+
+
+
+
+
+[generic-function] SHADER-SOURCE CLOG-WEBGL-SHADER SOURCE
+
+Sets shader source code
+
+
+
+
+
+[generic-function] SHADER-PARAMETER CLOG-WEBGL-SHADER GLENUM-PARAM
+
+Returns information about the given shader.
+:DELETE_STATUS
+Returns a GLboolean indicating whether or not the shader is flagged for deletion.
+
+:COMPILE_STATUS
+Returns a GLboolean indicating whether or not the last shader compilation was successful.
+
+:SHADER_TYPE
+Returns a GLenum indicating whether the shader is a vertex shader (gl.VERTEX_SHADER) or fragment shader (gl.FRAGMENT_SHADER) object.
+
+
+
+
+
+[generic-function] SHADER-INFO-LOG CLOG-WEBGL-SHADER
+
+It contains warnings, debugging and compile information.
+
+
+
+
+
+- [generic-function] COMPILE-SHADER OBJ
+
+
+
+
+
+- [generic-function] DELETE-SHADER OBJ
+
+
+CLOG-WebGL-Program - Class for CLOG WebGL-Program objects
+
+
+
+
+- [class] CLOG-WEBGL-PROGRAM CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-PROGRAM CLOG-WEBGL
+
+Create a clog-webgl-program
+
+
+
+
+
+[generic-function] IS-PROGRAM CLOG-WEBGL-PROGRAM
+
+Return true if is valid
+
+
+
+
+
+[generic-function] ATTACH-SHADER CLOG-WEBGL-PROGRAM CLOG-WEBGL-SHADER
+
+Attaches either a fragment or vertex CLOG-WEBGL-SHADER
+
+
+
+
+
+[generic-function] DETACH-SHADER CLOG-WEBGL-PROGRAM CLOG-WEBGL-SHADER
+
+Detaches a CLOG-WEBGL-SHADER
+
+
+
+
+
+[generic-function] BIND-ATTRIBUTE-LOCATION CLOG-WEBGL-PROGRAM INDEX NAME
+
+Binds a generic vertex INDEX to an attribute variable
+called NAME.
+
+
+
+
+
+[generic-function] PROGRAM-PARAMETER CLOG-WEBGL-PROGRAM GLENUM-PARAM
+
+Information about the given program.
+:DELETE_STATUS
+Returns a GLboolean indicating whether or not the program is flagged for deletion.
+
+:LINK_STATUS
+Returns a GLboolean indicating whether or not the last link operation was successful.
+
+:VALIDATE_STATUS
+Returns a GLboolean indicating whether or not the last validation operation was successful.
+
+:ATTACHED_SHADERS
+Returns a GLint indicating the number of attached shaders to a program.
+
+:ACTIVE_ATTRIBUTES
+Returns a GLint indicating the number of active attribute variables to a program.
+
+:ACTIVE_UNIFORMS
+Returns a GLint indicating the number of active uniform variables to a program.
+
+When using a WebGL 2 context, the following values are available additionally:
+
+:TRANSFORM_FEEDBACK_BUFFER_MODE
+Returns a GLenum indicating the buffer mode when transform feedback is active. May be :SEPARATE_ATTRIBS or :INTERLEAVED_ATTRIBS.
+
+:TRANSFORM_FEEDBACK_VARYINGS
+Returns a GLint indicating the number of varying variables to capture in transform feedback mode.
+
+:ACTIVE_UNIFORM_BLOCKS
+Returns a GLint indicating the number of uniform blocks containing active uniforms.
+
+
+
+
+
+[generic-function] ATTRIBUTE-LOCATION CLOG-WEBGL-PROGRAM NAME
+
+Returns the location of an attribute variable in clog-webgl-program
+
+
+
+
+
+[generic-function] UNIFORM-LOCATION CLOG-WEBGL-PROGRAM NAME
+
+Returns the location of an uniform variable in clog-webgl-program
+
+
+
+
+
+[generic-function] ACTIVE-ATTRIBUTE CLOG-WEBGL-PROGRAM INDEX
+
+Query about unknown attributes
+
+
+
+
+
+[generic-function] ACTIVE-UNIFORM CLOG-WEBGL-PROGRAM INDEX
+
+Query about unknown uniforms
+
+
+
+
+
+[generic-function] UNIFORM CLOG-WEBGL-PROGRAM LOCATION
+
+Returns the value of uniform at LOCATION in clog-webgl-program
+
+
+
+
+
+[generic-function] PROGRAM-INFO-LOG CLOG-WEBGL-PROGRAM
+
+Contains errors that occurred during failed linking or
+validation of WebGLProgram objects.
+
+
+
+
+
+- [generic-function] LINK-PROGRAM OBJ
+
+
+
+
+
+- [generic-function] USE-PROGRAM OBJ
+
+
+
+
+
+- [generic-function] DELETE-PROGRAM OBJ
+
+
+CLOG-WebGL-Buffer - Class for CLOG WebGL-Buffer objects
+
+
+
+
+- [class] CLOG-WEBGL-BUFFER CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-WEBGL-BUFFER CLOG-WEBGL &KEY BIND-TYPE
+
+Create a clog-webgl-buffer. If BIND-TYPE
+is set binds the buffer to either :ARRAY_BUFFER or :ELEMENT_ARRAY_BUFFER
+in WebGL2 the following added:
+:COPY_READ_BUFFER : Buffer for copying from one buffer object to another.
+:COPY_WRITE_BUFFER : Buffer for copying from one buffer object to another.
+:TRANSFORM_FEEDBACK_BUFFER : Buffer for transform feedback operations.
+:UNIFORM_BUFFER : Buffer used for storing uniform blocks.
+:PIXEL_PACK_BUFFER : Buffer used for pixel transfer operations.
+:PIXEL_UNPACK_BUFFER : Buffer used for pixel transfer operations.
+
+
+
+
+
+[generic-function] IS-BUFFER CLOG-WEBGL-BUFFER
+
+Return true if is valid
+
+
+
+
+
+[generic-function] BIND-BUFFER CLOG-WEBGL-BUFFER GLENUM-TARGET
+
+Set BIND-TYPE of buffer to either :ARRAY_BUFFER or
+:ELEMENT_ARRAY_BUFFER. WebGL2 adds:
+:COPY_READ_BUFFER : Buffer for copying from one buffer object to another.
+:COPY_WRITE_BUFFER : Buffer for copying from one buffer object to another.
+:TRANSFORM_FEEDBACK_BUFFER : Buffer for transform feedback operations.
+:UNIFORM_BUFFER : Buffer used for storing uniform blocks.
+:PIXEL_PACK_BUFFER : Buffer used for pixel transfer operations.
+:PIXEL_UNPACK_BUFFER : Buffer used for pixel transfer operations.
+
+
+
+
+
+[generic-function] BUFFER-DATA CLOG-WEBGL-BUFFER DATA-LIST DATA-TYPE GLENUM-USAGE
+
+Initializes and creates the buffer object's data store.
+DATA-LIST is a Lisp list of data elements.
+DATA-TYPE is the WebGL data type as a string "Float32Array"
+GLENUM-USAGE us a usage hint like :STATIC_DRAW
+
+
+
+
+
+[generic-function] BUFFER-SUB-DATA CLOG-WEBGL-BUFFER OFFSET DATA-LIST DATA-TYPE
+
+Initializes and creates the buffer object's data store.
+OFFSET element index offset where to start reading the buffer.
+DATA-LIST is a Lisp list of data elements.
+DATA-TYPE is the WebGL data type as a string "Float32Array"
+
+
+
+
+
+- [generic-function] DELETE-BUFFER OBJ
+
+
+CLOG-WebGL-Vertex-Array - Class for CLOG WebGL-Vertex-Array objects
+
+
+
+
+- [class] CLOG-WEBGL-VERTEX-ARRAY CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-VERTEX-ARRAY CLOG-WEBGL
+
+Create a clog-webgl-vertex-array
+
+
+
+
+
+- [generic-function] BIND-VERTEX-ARRAY OBJ
+
+
+
+
+
+- [generic-function] DELETE-VERTEX-ARRAY OBJ
+
+
+CLOG-WebGL-Frame-Buffer - Class for CLOG WebGL-Frame-Buffer objects
+
+
+
+
+- [class] CLOG-WEBGL-FRAME-BUFFER CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-WEBGL-FRAME-BUFFER CLOG-WEBGL &KEY BIND-TYPE
+
+Create a clog-webgl-frame-buffer. If BIND-TYPE
+is set binds the frame-buffer to :FRAMEBUFFER in WebGL2 the following are
+added:
+:DRAW_FRAMEBUFFER : Used as a destination for drawing operations such as draw,
+clear and blit-frame-buffer.
+:READ_FRAMEBUFFER : Used as a source for reading operations such as readPixels
+and blit-frame-buffer.
+
+
+
+
+
+[generic-function] IS-FRAME-BUFFER CLOG-WEBGL-FRAME-BUFFER
+
+Return true if is valid
+
+
+
+
+
+[generic-function] BIND-FRAME-BUFFER CLOG-WEBGL-FRAME-BUFFER GLENUM-TARGET
+
+Set BIND-TYPE of frame-buffer to :FRAMEBUFFER
+in WebGL2 the following are added:
+:DRAW_FRAMEBUFFER : Used as a destination for drawing operations such as draw,
+clear and blit-frame-buffer.
+:READ_FRAMEBUFFER : Used as a source for reading operations such as readPixels
+and blit-frame-buffer
+
+
+
+
+
+- [generic-function] DELETE-FRAME-BUFFER OBJ
+
+
+CLOG-WebGL-Render-Buffer - Class for CLOG WebGL-Render-Buffer objects
+
+
+
+
+- [class] CLOG-WEBGL-RENDER-BUFFER CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-WEBGL-RENDER-BUFFER CLOG-WEBGL &KEY BIND-TYPE
+
+Create a clog-webgl-render-buffer. If BIND-TYPE
+is set binds the render-buffer to :RENDERBUFFER
+
+
+
+
+
+[generic-function] IS-RENDER-BUFFER CLOG-WEBGL-RENDER-BUFFER
+
+Return true if is valid
+
+
+
+
+
+[generic-function] BIND-RENDER-BUFFER CLOG-WEBGL-RENDER-BUFFER GLENUM-TARGET
+
+Set BIND-TYPE of render-buffer to :RENDERBUFFER
+
+
+
+
+
+- [generic-function] DELETE-RENDER-BUFFER OBJ
+
+
+CLOG-WebGL-Texture - Class for CLOG WebGL-Texture objects
+
+
+
+
+- [class] CLOG-WEBGL-TEXTURE CLOG-OBJ
+
+
+
+
+
+[generic-function] CREATE-WEBGL-TEXTURE CLOG-WEBGL &KEY BIND-TYPE
+
+Create a clog-webgl-texture. If BIND-TYPE
+is set binds the texture to:
+:TEXTURE_2D : A two-dimensional texture.
+:TEXTURE_CUBE_MAP : A cube-mapped texture.
+in WebGL 2 also:
+:TEXTURE_3D : A three-dimensional texture.
+:TEXTURE_2D_ARRAY : A two-dimensional array texture.
+
+
+
+
+
+[generic-function] IS-TEXTURE CLOG-WEBGL-TEXTURE
+
+Return true if is valid
+
+
+
+
+
+[generic-function] BIND-TEXTURE CLOG-WEBGL-TEXTURE GLENUM-TARGET
+
+Set BIND-TYPE of texture to:
+:TEXTURE_2D : A two-dimensional texture.
+:TEXTURE_CUBE_MAP : A cube-mapped texture.
+in WebGL 2 also:
+:TEXTURE_3D : A three-dimensional texture.
+:TEXTURE_2D_ARRAY : A two-dimensional array texture.
+
+
+
+
+
+- [generic-function] DELETE-TEXTURE OBJ
+
+
-
+
-16 CLOG Multimedia Objects
+17 CLOG Multimedia Objects
CLOG-Multimedia - Base Class for CLOG multimedia objects
@@ -6237,7 +8049,7 @@ is nil unbind the event.
-17 CLOG Auth Objects
+18 CLOG Auth Objects
[in package CLOG-AUTH]
@@ -6298,7 +8110,7 @@ is nil unbind the event.
-18 CLOG GUI Objects
+19 CLOG GUI Objects
[in package CLOG-GUI]
@@ -6802,7 +8614,7 @@ machine, upon close ON-FILE-NAME called with filename or nil if fai
-19 CLOG Web Objects
+20 CLOG Web Objects
[in package CLOG-WEB]
@@ -7559,7 +9371,7 @@ and no-script body information for search engines with DESCRIPTION.
-20 CLOG Web DBI
+21 CLOG Web DBI
[in package CLOG-WEB-DBI]
@@ -7654,7 +9466,7 @@ optional WHERE and ORDER-BY sql.
-21 CLOG Web Site Themes
+22 CLOG Web Site Themes
[in package CLOG-WEB]
@@ -7704,7 +9516,7 @@ Page properties:
-22 CLOG Body Objects
+23 CLOG Body Objects
CLOG-Body - CLOG Body Objects
@@ -7780,7 +9592,7 @@ replace the browser contents with HTML.
-23 CLOG Window Objects
+24 CLOG Window Objects
CLOG-Window - CLOG Window Objects
@@ -8185,7 +9997,7 @@ on-storage event is fired for changes to :local storage keys.
-24 CLOG Document Objects
+25 CLOG Document Objects
CLOG-Document - CLOG Document Objects
@@ -8373,7 +10185,7 @@ The handler should be installed on the document before calling load-script.<
-25 CLOG Location Objects
+26 CLOG Location Objects
Clog-Location - CLOG Location Objects
@@ -8504,7 +10316,7 @@ saved in session history and back button will not return to it.
-26 CLOG Navigator Objects
+27 CLOG Navigator Objects
CLOG-Navigator - CLOG Navigator Objects
@@ -8580,7 +10392,7 @@ saved in session history and back button will not return to it.
-27 CLOG jQuery Objects
+28 CLOG jQuery Objects
CLOG-jQuery - Base class for CLOG jQuery Objects
@@ -8591,7 +10403,7 @@ saved in session history and back button will not return to it.
[class] CLOG-JQUERY CLOG-ELEMENT
CLOG jQuery objects. A jQuery representa DOM queries that
-can represent one or even my CLOG objects as a single element.
+can represent one or even many CLOG objects as a single element.
CLOG-jQuery creation
@@ -8647,7 +10459,7 @@ result or DEFAULT-ANSWER on time out.
-28 CLOG Helper Functions
+29 CLOG Helper Functions
Tutorial and demo helpers
@@ -8766,7 +10578,7 @@ set (logging to browser console),
-29 CLOG Framework internals and extensions
+30 CLOG Framework internals and extensions
* Introduction to Internals *
diff --git a/make-docs b/make-docs
new file mode 100755
index 0000000..5661949
--- /dev/null
+++ b/make-docs
@@ -0,0 +1 @@
+sbcl --dynamic-space-size 10240 --eval "(ql:quickload :clog/docs)" --eval "(clog:make-html)"
diff --git a/source/clog-docs.lisp b/source/clog-docs.lisp
index d9be5ae..e1228a8 100644
--- a/source/clog-docs.lisp
+++ b/source/clog-docs.lisp
@@ -86,15 +86,8 @@ frameworks and website frameworks. The CLOG package starts up the
connectivity to the browser or other websocket client (often a browser
embedded in a native template application.)
-STATUS: CLOG is complete and all work is on higher order additions,
-such as full desktop over the web, database tools,etc. See below for
-some enhacements being worked on. CLOG is actually based on GNOGA, a
-framework I wrote for Ada in 2013 and used in commercial production
-code for the last 8+ years, i.e. the techniques CLOG uses are solid
-and proven.
-
-CLOG is being actively extended daily. Check the github discussion
-boards for the latest.
+STATUS: CLOG's API is mature and stable. Tools and new plugins always in
+the works. Check the github discussion boards for the latest.
Some potential applications for CLOG:
diff --git a/source/clog-webgl.lisp b/source/clog-webgl.lisp
index ba1472c..300adbc 100644
--- a/source/clog-webgl.lisp
+++ b/source/clog-webgl.lisp
@@ -202,8 +202,7 @@ can be webgl (version 1) or webgl2 (default)"))
(defgeneric buffer-parameter (clog-webgl glenum-target glenum-pname)
(:documentation "Returns information about the buffer.
-target
-------
+target:
A GLenum specifying the target buffer object. Possible values:
:ARRAY_BUFFER
@@ -232,8 +231,7 @@ Buffer used for pixel transfer operations.
:PIXEL_UNPACK_BUFFER
Buffer used for pixel transfer operations.
-pname
------
+pname:
A GLenum specifying information to query. Possible values:
:BUFFER_SIZE
@@ -298,8 +296,7 @@ When using a WebGL 2 context, the following values are available additionally:
(defgeneric vertex-attribute (clog-webgl index glenum-pname)
(:documentation "Information about a vertex attribute at a given position.
-pname
------
+pname:
A GLenum specifying the information to query. Possible values:
:VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
@@ -673,8 +670,7 @@ When using a WebGL 2 context, the following values are available additionally:
(:documentation "Hints for certain behaviors. The interpretation of these
hints depend on the implementation.
-target
-------
+target:
Sets which behavior to be controlled. Possible values:
:GENERATE_MIPMAP_HINT
@@ -690,8 +686,7 @@ When using a WebGL 2 context, the following values are available additionally:
:FRAGMENT_SHADER_DERIVATIVE_HINT
Same as ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES
-mode
-----
+mode:
Sets the behavior. The default value is :DONT_CARE. The possible values are:
:FASTEST : The most efficient behavior should be used.
diff --git a/source/clog.lisp b/source/clog.lisp
index 2e5261d..6a61372 100644
--- a/source/clog.lisp
+++ b/source/clog.lisp
@@ -786,7 +786,7 @@ embedded in a native template application.)"
(measure-text generic-function)
(move-to generic-function)
(put-image-data generic-function)
- (put-image-dirty generic-function)
+ (put-image-data-dirty generic-function)
(quadratic-curve-to generic-function)
(rect generic-function)
(reset-transform generic-function)
@@ -804,8 +804,8 @@ embedded in a native template application.)"
(translate generic-function)
"CLOG-Canvas-Gradient"
- (clog-canvas-gradien class)
- (add-color-stop generic-function)
+ (clog-canvas-gradient class)
+ (add-color-stop generic-function)
"CLOG-Image-Data"
(clog-image-data class)
@@ -817,7 +817,7 @@ embedded in a native template application.)"
(flip-x generic-function)
(flip-y generic-function)
(inverse generic-function)
- (mutliply generic-function)
+ (multiply generic-function)
(rotate generic-function)
(scale-matrix generic-function)
(scale3d generic-function)