doc updates

This commit is contained in:
David Botton 2022-08-22 16:27:12 -04:00
parent bd24c631de
commit c65e0a2856
5 changed files with 2143 additions and 342 deletions

File diff suppressed because it is too large Load diff

1
make-docs Executable file
View file

@ -0,0 +1 @@
sbcl --dynamic-space-size 10240 --eval "(ql:quickload :clog/docs)" --eval "(clog:make-html)"

View file

@ -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 connectivity to the browser or other websocket client (often a browser
embedded in a native template application.) embedded in a native template application.)
STATUS: CLOG is complete and all work is on higher order additions, STATUS: CLOG's API is mature and stable. Tools and new plugins always in
such as full desktop over the web, database tools,etc. See below for the works. Check the github discussion boards for the latest.
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.
Some potential applications for CLOG: Some potential applications for CLOG:

View file

@ -202,8 +202,7 @@ can be webgl (version 1) or webgl2 (default)"))
(defgeneric buffer-parameter (clog-webgl glenum-target glenum-pname) (defgeneric buffer-parameter (clog-webgl glenum-target glenum-pname)
(:documentation "Returns information about the buffer. (:documentation "Returns information about the buffer.
target target:
------
A GLenum specifying the target buffer object. Possible values: A GLenum specifying the target buffer object. Possible values:
:ARRAY_BUFFER :ARRAY_BUFFER
@ -232,8 +231,7 @@ Buffer used for pixel transfer operations.
:PIXEL_UNPACK_BUFFER :PIXEL_UNPACK_BUFFER
Buffer used for pixel transfer operations. Buffer used for pixel transfer operations.
pname pname:
-----
A GLenum specifying information to query. Possible values: A GLenum specifying information to query. Possible values:
:BUFFER_SIZE :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) (defgeneric vertex-attribute (clog-webgl index glenum-pname)
(:documentation "Information about a vertex attribute at a given position. (:documentation "Information about a vertex attribute at a given position.
pname pname:
-----
A GLenum specifying the information to query. Possible values: A GLenum specifying the information to query. Possible values:
:VERTEX_ATTRIB_ARRAY_BUFFER_BINDING :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 (:documentation "Hints for certain behaviors. The interpretation of these
hints depend on the implementation. hints depend on the implementation.
target target:
------
Sets which behavior to be controlled. Possible values: Sets which behavior to be controlled. Possible values:
:GENERATE_MIPMAP_HINT :GENERATE_MIPMAP_HINT
@ -690,8 +686,7 @@ When using a WebGL 2 context, the following values are available additionally:
:FRAGMENT_SHADER_DERIVATIVE_HINT :FRAGMENT_SHADER_DERIVATIVE_HINT
Same as ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES Same as ext.FRAGMENT_SHADER_DERIVATIVE_HINT_OES
mode mode:
----
Sets the behavior. The default value is :DONT_CARE. The possible values are: Sets the behavior. The default value is :DONT_CARE. The possible values are:
:FASTEST : The most efficient behavior should be used. :FASTEST : The most efficient behavior should be used.

View file

@ -786,7 +786,7 @@ embedded in a native template application.)"
(measure-text generic-function) (measure-text generic-function)
(move-to generic-function) (move-to generic-function)
(put-image-data generic-function) (put-image-data generic-function)
(put-image-dirty generic-function) (put-image-data-dirty generic-function)
(quadratic-curve-to generic-function) (quadratic-curve-to generic-function)
(rect generic-function) (rect generic-function)
(reset-transform generic-function) (reset-transform generic-function)
@ -804,7 +804,7 @@ embedded in a native template application.)"
(translate generic-function) (translate generic-function)
"CLOG-Canvas-Gradient" "CLOG-Canvas-Gradient"
(clog-canvas-gradien class) (clog-canvas-gradient class)
(add-color-stop generic-function) (add-color-stop generic-function)
"CLOG-Image-Data" "CLOG-Image-Data"
@ -817,7 +817,7 @@ embedded in a native template application.)"
(flip-x generic-function) (flip-x generic-function)
(flip-y generic-function) (flip-y generic-function)
(inverse generic-function) (inverse generic-function)
(mutliply generic-function) (multiply generic-function)
(rotate generic-function) (rotate generic-function)
(scale-matrix generic-function) (scale-matrix generic-function)
(scale3d generic-function) (scale3d generic-function)