mirror of https://github.com/Relintai/sfw.git
Added markdeep as a base for docs.
This commit is contained in:
parent
2c56e35963
commit
24480d3195
|
|
@ -0,0 +1,25 @@
|
|||
BSD 2-Clause License
|
||||
|
||||
Copyright (c) 2020, Morgan McGuire
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# Markdeep
|
||||
Official public mirror of Markdeep by Morgan McGuire. BSD License.
|
||||
|
||||
See the [Markdeep homepage](https://casual-effects.com/markdeep) for documentation and a hosted
|
||||
version.
|
||||
|
||||
I do not accept pull requests through this repository because this is a
|
||||
mirror of the private repo. Email <morgan@casual-effects.com> to discuss features.
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
<meta charset="utf-8">
|
||||
**Sample API Doc**
|
||||
1.1 Release
|
||||
|
||||
|
||||
This is the markdeep generic "Company API" template. Replace
|
||||
`company-logo-512.png` with your organization's logo and adjust the
|
||||
`company-api.css` styling to match the desired colors.
|
||||
|
||||
See `CA::OpenHandle()` for an example of an auto-generated API link.
|
||||
The rest of the information on this page is bogus placeholder to show the formatting.
|
||||
|
||||
|
||||
API Modules
|
||||
====================================================================================
|
||||
|
||||
The CA library is a layer on top of the resource manager and parsing libraries that
|
||||
provides utilities for streaming processing and client-side process construction.
|
||||
|
||||
|
||||
Modules
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
The CA library contains the APIs for applications to allocate and exchange resources.
|
||||
|
||||
|
||||
!!! Attention Attention
|
||||
Always read all of the documentation.
|
||||
|
||||
[CA APIs](#CA)
|
||||
: List of APIs to manage external processes.
|
||||
|
||||
CA Buffer List APIs
|
||||
: Methods to process buffer resources separate from computation.
|
||||
|
||||
CA Data Structures
|
||||
: Specifies the data structures used for complex cases.
|
||||
|
||||
|
||||
## Handles
|
||||
|
||||
`CA::OpenHandle(const std::string&)`
|
||||
: Open a reference handle.
|
||||
|
||||
`CA::ReadMetaData(const Handle&)`
|
||||
: Metadata about the event.
|
||||
|
||||
`CA::CloseHandle(const Handle&)`
|
||||
: Free all handle resources, recursively.
|
||||
|
||||
|
||||
CA
|
||||
====================================================================================
|
||||
|
||||
!!! Warning Warning
|
||||
The API content represents the set of APIs you can use directly. Some APIs
|
||||
are not documented and we advise you do not use them directly. Using undocumented
|
||||
APIs can lead to incompatibility when upgrading to later releases.
|
||||
|
||||
|
||||
These examples assume that your directory structure is:
|
||||
|
||||
**********************************************************
|
||||
*
|
||||
* 📂 ca1
|
||||
* |
|
||||
* +-- 📄 bar.txt
|
||||
* |
|
||||
* +-- 📂 foo
|
||||
* | |
|
||||
* | ⋮
|
||||
* |
|
||||
* +-- 📂 xsource
|
||||
* | |
|
||||
* | +-- 📂 data
|
||||
* | | |
|
||||
* | | +-- 📄 manifest.json
|
||||
* | | |
|
||||
* | ⋮ ⋮
|
||||
* |
|
||||
* ⋮
|
||||
**********************************************************
|
||||
[Directory structure.]
|
||||
|
||||
|
||||
Table
|
||||
------------------------------------------------------------------
|
||||
|
||||
|
||||
Screen | Factor | Used | Efficiency
|
||||
----------:|------------:|----------:|---------:
|
||||
1366x768 | 3x | 1152x672 | 74%
|
||||
1440x900 | 3x | 1152x672 | 60%
|
||||
*1600x900* | *4x* | 1536x896 | *96%*
|
||||
1680x1050 | 4x | 1536x896 | 78%
|
||||
1920x1080 | 4x | 1536x896 | 66%
|
||||
*1920x1200*| *5x* | 1920x1120 | *93%*
|
||||
[A Table]
|
||||
|
||||
|
||||
More Info
|
||||
------------------------------------------------------------------
|
||||
|
||||
******************************************************************
|
||||
* ^ y
|
||||
* |
|
||||
* .---------. .----|----.
|
||||
* | | | | |
|
||||
* | *-------> x | *--------> x
|
||||
* | | | | |
|
||||
* '----|----' '---------'
|
||||
* |
|
||||
* v y
|
||||
******************************************************************
|
||||
[Figure 1: Coordinate Example]
|
||||
|
||||
|
||||
-----
|
||||
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ GLSL
|
||||
vec3 sphNormal(in vec3 pos, in vec4 sph) {
|
||||
return normalize(pos-sph.xyz);
|
||||
}
|
||||
|
||||
vec3 camera(vec2 U, vec2 r, vec3 ro, vec3 la, float fl) {
|
||||
vec2 uv = (U - r*.5)/r.y;
|
||||
vec3 fwd = normalize(la-ro),
|
||||
rgt = normalize(vec3(fwd.z, 0., -fwd.x));
|
||||
return normalize(fwd + fl*uv.x*rgt + fl*uv.y*cross(fwd, rgt));
|
||||
}
|
||||
|
||||
float vMap(vec3 p) {
|
||||
float hit = 0.0;
|
||||
vec2 h2 = hash22(floor(p.xz*0.25));
|
||||
if (p.z > 0.0) {
|
||||
if (p.y < -10.0 && h2.x > 0.5) hit=1.0;
|
||||
if (p.y > 10.0 && h2.y > 0.5) hit=1.0;
|
||||
}
|
||||
return hit;
|
||||
}
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
[Code listing]
|
||||
|
||||
<script>markdeepOptions = {tocStyle:'long', definitionStyle:'long', linkAPIDefinitions: true};</script>
|
||||
<link rel="stylesheet" href="slate.css">
|
||||
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js"></script><script src="https://casual-effects.com/markdeep/latest/markdeep.min.js?"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>
|
||||
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,249 @@
|
|||
body#md {
|
||||
font-weight: 400;
|
||||
font-size: 16px;
|
||||
font-family: Arial, Helvetica, "sans serif";
|
||||
text-align: left;
|
||||
line-height: 170%;
|
||||
}
|
||||
|
||||
|
||||
/* reset heading/link fonts to that of body */
|
||||
.md a,
|
||||
.md div.title, contents, .md .tocHeader,
|
||||
.md h1, .md h2, .md h3, .md h4, .md h5, .md h6,
|
||||
.md .nonumberh1, .md .nonumberh2, .md .nonumberh3, .md .nonumberh4, .md .nonumberh5, .md .nonumberh6,
|
||||
.md .shortTOC, .md .mediumTOC, .md .longTOC {
|
||||
font-family: inherit;
|
||||
}
|
||||
|
||||
.md .tocHeader {
|
||||
border: none;
|
||||
margin-top: 25px;
|
||||
font-size: 100%;
|
||||
font-family: inherit;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
.md .longTOC .level1 {
|
||||
font-weight: 300;
|
||||
margin-bottom: -30px;
|
||||
}
|
||||
|
||||
.md div.title, .md div.subtitle, .md h1, .md h2, .md h3, .md h4, .md h5, .md h6 {
|
||||
font-family: Arial, Helvetica, "sans serif";
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
.md div.title {
|
||||
font-size: 43px;
|
||||
text-align: left;
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
.md div.subtitle {
|
||||
text-align: left;
|
||||
font-size: 115%;
|
||||
}
|
||||
|
||||
.md div.afterTitles {
|
||||
margin-top: 20px;
|
||||
margin-left: -20px;
|
||||
margin-right: -20px;
|
||||
height: 0px;
|
||||
border-bottom: 1px solid #000;
|
||||
box-shadow: 0px 1px 2px rgba(0,0,0,0.5);
|
||||
}
|
||||
|
||||
.md div.afterTitles + p {
|
||||
margin-top: 30px;
|
||||
}
|
||||
|
||||
.md h1 {
|
||||
font-size: 175%;
|
||||
margin-bottom: 25px;
|
||||
margin-left:-20px;
|
||||
margin-right:-20px;
|
||||
padding-left:20px;
|
||||
padding-top:25px;
|
||||
border-bottom: none;
|
||||
border-top:6px solid #5a5a5a;
|
||||
}
|
||||
|
||||
.md h2 {
|
||||
font-size: 150%;
|
||||
border: none;
|
||||
}
|
||||
|
||||
.md h3, .md h4, .md h5, .md h6 {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
.md code {
|
||||
font-size: 90%;
|
||||
background: #eee;
|
||||
padding-left: 2px;
|
||||
padding-right: 2px;
|
||||
}
|
||||
|
||||
.md .longTOC {
|
||||
font-family: 'Roboto', Arial, Helvetica, "sans serif";
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
|
||||
.md pre.listing {
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.md pre.listing code {
|
||||
font-weight: unset;
|
||||
background: none;
|
||||
color: unset;
|
||||
}
|
||||
|
||||
|
||||
/* Darkmode, wide screen: TOC on side */
|
||||
@media screen and (min-device-width: 600px) {
|
||||
.md .longTOC {
|
||||
display: block;
|
||||
white-space: nowrap;
|
||||
width: 170px;
|
||||
border-right: 1px solid #777;
|
||||
overflow-y:scroll;
|
||||
font-family: inherit;
|
||||
background: #202020;
|
||||
position: fixed;
|
||||
left: 0px;
|
||||
top: 0px;
|
||||
bottom:0px;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
padding-left:10px;
|
||||
}
|
||||
|
||||
body {
|
||||
position: absolute;
|
||||
left: 200px;
|
||||
right:0px;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
max-width: unset;
|
||||
padding-right: 15px;
|
||||
}
|
||||
}
|
||||
|
||||
/* Dark mode with side TOC on screen */
|
||||
@media screen {
|
||||
.md div.longTOC {
|
||||
font-size: 15px;
|
||||
}
|
||||
|
||||
|
||||
.md svg.diagram {
|
||||
stroke: #ccc;
|
||||
fill: #ccc;
|
||||
}
|
||||
|
||||
.md svg.diagram .opendot {
|
||||
fill: #000;
|
||||
}
|
||||
|
||||
.md table.table {
|
||||
box-shadow: 0px 1px 2px rgba(0,0,0,0.5);
|
||||
background-color: #2a2a2a;
|
||||
}
|
||||
|
||||
.md table.table tr:nth-child(even) {
|
||||
background-color: #202020;
|
||||
}
|
||||
|
||||
.md table.table td, .md table.table th {
|
||||
border: 1px solid #202020;
|
||||
}
|
||||
|
||||
.md table.table th {
|
||||
color: #000;
|
||||
}
|
||||
|
||||
.md pre.listing {
|
||||
background: #202020;
|
||||
border: 1px solid #777;
|
||||
box-shadow: 0px 1px 2px rgba(0,0,0,0.5);
|
||||
}
|
||||
|
||||
.md code {
|
||||
color: #fff;
|
||||
background: unset;
|
||||
}
|
||||
|
||||
.md .tocTop {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.md div.afterTitles {
|
||||
border-bottom: 1px solid #fff;
|
||||
}
|
||||
|
||||
.md div.title, .md div.subtitle, .md h1, .md h2, .md h3, .md h4, .md h5, .md h6 {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.hljs-comment,.hljs-quote{color:#a0f0aa}.hljs-variable,.hljs-template-variable,.hljs-tag,.hljs-name,.hljs-selector-id,.hljs-selector-class,.hljs-regexp,.hljs-deletion{color:#cc6666}.hljs-number,.hljs-built_in,.hljs-builtin-name,.hljs-literal,.hljs-type,.hljs-params,.hljs-meta,.hljs-link{color:#de935f}.hljs-attribute{color:#f0c674}.hljs-string,.hljs-symbol,.hljs-bullet,.hljs-addition{color:#b5bd68}.hljs-title,.hljs-section{color:#81a2be}.hljs-keyword,.hljs-selector-tag{color:#b294bb}.hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:bold}
|
||||
.hljs-function .hljs-title { color:#81a2be}
|
||||
|
||||
body {
|
||||
color: #ccc;
|
||||
background: #3a3a3a;
|
||||
}
|
||||
|
||||
.md div.title, .md h1, .md h2, .md h3, .md h4, .md h5, .md h6, .md .longTOC a, .md .longTOC code, .md a:link, .md a:visited {
|
||||
text-shadow: 0px 1px 2px rgba(0,0,0,0.5);
|
||||
}
|
||||
|
||||
.md .admonition {
|
||||
position: unset;
|
||||
box-shadow: 0px 1px 2px rgba(0,0,0,0.5);
|
||||
background: #202020;
|
||||
border: 1px solid rgba(68,138,255,1);
|
||||
border-left: 2.5rem solid rgba(68,138,255,1);
|
||||
}
|
||||
|
||||
.md .admonition-title {
|
||||
border-bottom: 1px solid rgba(68,138,255,1);
|
||||
}
|
||||
|
||||
.md .admonition.warn, .md .admonition.warning {
|
||||
border: 1px solid rgba(255,170,0,1);
|
||||
border-left: 2.5rem solid rgba(255,170,0,1);
|
||||
background: #202020;
|
||||
}
|
||||
|
||||
.md .admonition.warn .admonition-title, .md .admonition.warning .admonition-title {
|
||||
border-bottom: 1px solid rgba(68,138,255,1);
|
||||
}
|
||||
|
||||
.md .admonition.tip {
|
||||
border: 1px solid rgba(68,138,255,1);
|
||||
border-left: 2.5rem solid rgba(68,138,255,1);
|
||||
background: #202020;
|
||||
}
|
||||
.md .admonition.tip .admonition-title {
|
||||
border-bottom: 1px solid rgba(68,138,255,1);
|
||||
}
|
||||
|
||||
.md .admonition.error {
|
||||
border: 1px solid rgba(255,23,68,1);
|
||||
border-left: 2.5rem solid rgba(255,23,68,1);
|
||||
background: #202020;
|
||||
}
|
||||
|
||||
.md .admonition.error .admonition-title {
|
||||
border-bottom: 1px solid rgba(255,23,68,1);
|
||||
}
|
||||
|
||||
.md .longTOC a, .md .longTOC code, .md a:link, .md a:visited, .md a:link code, .md a:visited code {
|
||||
color: #80bfff !important;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue