Skip to content

Commit 4175ccd

Browse files
committed
Generate proper Docs
1 parent 7f2604d commit 4175ccd

File tree

398 files changed

+578
-100161
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

398 files changed

+578
-100161
lines changed

Doxyfile

Lines changed: 303 additions & 150 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,8 @@
55

66
[PS2GL Documentation](https://ps2dev.github.io/ps2gl/)
77

8-
All of the documentation has been moved to the docs/html directory..
8+
ps2gl is an OpenGL*-like API for the ps2. It is intended to be useful for anyone looking for a familiar API on the ps2, but its main purposes in life are to provide an easier way to write games and to serve as an example of a ps2 rendering layer. In a perfect world ps2gl would be just another OpenGL* implementation, but unfortunately, that is not to be. The reason, aside from licensing issues, is that many parts of the OpenGL* API are not well suited to the PlayStation 2 architecture and would require software emulation, which is undesirable.
9+
10+
Still, all hope is not lost; many of the calls act the same as their OpenGL* counterparts, while the rest behave similarly.
11+
12+
Finally, ps2gl is still quite young, and developers who decide to use it can expect to find bugs, inconsistencies, and incomplete features. Since ps2gl is also an open source project, its users are **welcome to participate in its development**. One of ps2gl's main design requirements is that it be easy to understand and modify. CVS (version control) write access is available to frequent contributors, and read access to the working CVS tree is always available.

docs/code.css

Lines changed: 270 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
1+
/* Fonts used: DejaVu Sans, DejaVu Sans Mono, Noto Sans */
2+
3+
body, table, div, p, dl {
4+
font: 400 14px/22px DejaVu Sans,sans-serif;
5+
}
6+
7+
body {
8+
background-color: #FDF6E3;
9+
color: #001B36;
10+
margin: 0;
11+
}
12+
13+
/* Disable cyan glow effect that only appears randomly. */
14+
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
15+
text-shadow: none;
16+
}
17+
18+
/* Table of contents index, for larger text. */
19+
div.toc h3 {
20+
font: bold 14px/1.2 DejaVu Sans,sans-serif;
21+
color: #174E86;
22+
border-bottom: 0 none;
23+
margin: 0;
24+
}
25+
26+
div.toc li {
27+
background: url("bdwn.png") no-repeat scroll 0 5px transparent;
28+
font: 12px/1.2 DejaVu Sans,Geneva,sans-serif;
29+
margin-top: 5px;
30+
padding-left: 10px;
31+
padding-top: 2px;
32+
}
33+
34+
/* These should have a white background to set them out. */
35+
dl.note {
36+
background-color: #FFF;
37+
margin-left: -7px;
38+
padding-left: 3px;
39+
border-left: 4px solid;
40+
border-color: #D0C000;
41+
}
42+
43+
dl.warning, dl.attention {
44+
background-color: #FFF;
45+
margin-left: -7px;
46+
padding-left: 3px;
47+
border-left: 4px solid;
48+
border-color: #FF0000;
49+
}
50+
51+
dl.bug {
52+
background-color: #FFF;
53+
margin-left: -7px;
54+
padding-left: 3px;
55+
border-left: 4px solid;
56+
border-color: #C08050;
57+
}
58+
59+
/* Alphabetical index letter headings don't match other headings. */
60+
div.ah, span.ah {
61+
background-color: #10365D;
62+
font-weight: bold;
63+
color: #FFF;
64+
margin-bottom: 3px;
65+
margin-top: 3px;
66+
padding: 0.3em;
67+
padding-right: 50%;
68+
border: solid thin #333;
69+
border-radius: 0.5em;
70+
-webkit-border-radius: .5em;
71+
-moz-border-radius: .5em;
72+
box-shadow: 2px 2px 3px #999;
73+
-webkit-box-shadow: 2px 2px 3px #999;
74+
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
75+
background-image: none;
76+
77+
}
78+
79+
/* Various things that declare their color dark. */
80+
div.summary a {
81+
white-space: nowrap;
82+
color: #FFF;
83+
}
84+
85+
div.ingroups a {
86+
white-space: nowrap;
87+
color: #FFF;
88+
}
89+
90+
/* Various things that declare their background-color white. */
91+
div.header {
92+
background-image: none;
93+
background-repeat: repeat-x;
94+
background-color: #10365D;
95+
color: #FFF;
96+
margin: 0px;
97+
border-bottom: 1px solid #98C3ED;
98+
}
99+
100+
101+
.directory tr.even {
102+
padding-left: 6px;
103+
background-color: #FDF6E3;
104+
}
105+
106+
.mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams {
107+
background-color: #FEF7E4;
108+
border: none;
109+
margin: 4px;
110+
padding: 1px 0 0 8px;
111+
}
112+
113+
.memdoc, dl.reflist dd {
114+
border-bottom: 1px solid #6AA7E5;
115+
border-left: 1px solid #6AA7E5;
116+
border-right: 1px solid #6AA7E5;
117+
padding: 6px 10px 2px 10px;
118+
background-color: #F8FBFD;
119+
border-top-width: 0;
120+
background-image: url('nav_g.png');
121+
background-repeat: repeat-x;
122+
background-color: #FDF6E3;
123+
border-bottom-left-radius: 4px;
124+
border-bottom-right-radius: 4px;
125+
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
126+
-moz-border-radius-bottomleft: 4px;
127+
-moz-border-radius-bottomright: 4px;
128+
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
129+
-webkit-border-bottom-left-radius: 4px;
130+
-webkit-border-bottom-right-radius: 4px;
131+
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
132+
}
133+
134+
/* Project style */
135+
#projectname {
136+
font: 300% Noto Sans,sans-serif;
137+
margin: 0px;
138+
padding: 2px 0px;
139+
}
140+
141+
#projectbrief {
142+
font: 100% DejaVu Sans,sans-serif;
143+
margin: 0px;
144+
padding: 0px;
145+
}
146+
147+
#projectnumber {
148+
font: 75% Noto Sans,sans-serif;
149+
margin: 0px;
150+
padding: 0px;
151+
}
152+
153+
/* Nav tree background */
154+
#nav-tree {
155+
background-image: none;
156+
background-repeat: repeat-x;
157+
background-color: #FDF6E3;
158+
-webkit-overflow-scrolling: touch;
159+
}
160+
161+
/* @group Code Colorization
162+
Based on Solarized Dark with a blue tweak. */
163+
div.fragment {
164+
color: #93A1A1;
165+
background-color: #001B36;
166+
font-family: DejaVu Sans Mono, fixed;
167+
font-size: 13px;
168+
min-height: 13px;
169+
line-height: 1.0;
170+
padding: 4px 6px;
171+
margin: 4px 8px 4px 2px;
172+
border: 1px solid #98C3ED;
173+
}
174+
175+
div.line {
176+
color: #93A1A1;
177+
background-color: #001B36;
178+
font-family: DejaVu Sans Mono, fixed;
179+
font-size: 13px;
180+
min-height: 13px;
181+
line-height: 1.0;
182+
text-wrap: unrestricted;
183+
white-space: -moz-pre-wrap;
184+
white-space: -pre-wrap;
185+
white-space: -o-pre-wrap;
186+
white-space: pre-wrap;
187+
word-wrap: break-word;
188+
text-indent: -53px;
189+
padding-left: 53px;
190+
padding-bottom: 0px;
191+
margin: 0px;
192+
-webkit-transition-property: background-color, box-shadow;
193+
-webkit-transition-duration: 0.5s;
194+
-moz-transition-property: background-color, box-shadow;
195+
-moz-transition-duration: 0.5s;
196+
-ms-transition-property: background-color, box-shadow;
197+
-ms-transition-duration: 0.5s;
198+
-o-transition-property: background-color, box-shadow;
199+
-o-transition-duration: 0.5s;
200+
transition-property: background-color, box-shadow;
201+
transition-duration: 0.5s;
202+
}
203+
204+
span.keyword {
205+
color: #B58900;
206+
font-weight: bold;
207+
}
208+
209+
span.keywordtype {
210+
color: #B58900;
211+
font-weight: bold;
212+
}
213+
214+
span.keywordflow {
215+
color: #DC322F;
216+
}
217+
218+
span.comment {
219+
color: #586E75;
220+
}
221+
222+
span.preprocessor {
223+
color: #6C71C4;
224+
}
225+
226+
span.stringliteral {
227+
color: #2AA198;
228+
}
229+
230+
span.charliteral {
231+
color: #2AA198;
232+
}
233+
234+
span.vhdldigit {
235+
color: #859900;
236+
}
237+
238+
span.vhdlchar {
239+
color: #859900;
240+
}
241+
242+
span.vhdlkeyword {
243+
color: #839496;
244+
}
245+
246+
span.vhdllogic {
247+
color: #839496;
248+
}
249+
250+
/* Line numbers and separator. */
251+
span.lineno {
252+
padding-right: 4px;
253+
text-align: right;
254+
border-right: 2px solid #DDD;
255+
color: #93A1A1;
256+
background-color: #072642;
257+
white-space: pre;
258+
}
259+
260+
span.lineno a {
261+
background-color: #072642;
262+
}
263+
264+
/* Color of links in code. */
265+
a.code, a.code:visited, a.line, a.line:visited {
266+
color: #93A1A1;
267+
}
268+
269+
270+
/* @end */

0 commit comments

Comments
 (0)