Skip to content

Commit da24352

Browse files
mardyWinterMute
authored andcommitted
Update README
1 parent 94b3aab commit da24352

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,24 @@ OpenGX
22
======
33

44
OpenGX is an OpenGL-like wrapper which sits on GX subsystem. It implements the most common OpenGL calls such as immediate mode, texturing, array drawing (indexed and not indexed), matrix operations and basic lighting. It features some advanced stuff such as automatic texture compression (ARB extension) and mipmapping. Beware! Some parts are currently NOT opengl compilant (speaking strictly).
5-
TODO list
6-
7-
* Fix lighting transform (which is buggy) and implement spotlights (untested)
8-
* Fix texture allocation. Now it's mandatory to allocate a texture name using glGen and you can't just bind the texture and use it
9-
* Complete glGet call
10-
* Add support for attribute push/pop
11-
* Add support for glReadPixels and similar calls
12-
13-
List of features (detailed but not exhaustive)
14-
15-
* Texture conversion/compression. Accepts RGB,RGBA,COMPRESSED_RGBA and LUMINANCE_ALPHA.
16-
* Matrix math stuff including glu calls
17-
* Texture mipmapping (and gluBuildMipMaps)
18-
* Texture sub-images
19-
* Texture coordinate generation
20-
* Ambient and diffuse, emission and specular lighting
21-
* Indexed and not indexed draw modes
22-
* Blending support
23-
* Alpha compare
24-
* Call lists
25-
* Fog
26-
* Selection mode
5+
6+
Current status
7+
--------------
8+
9+
OpenGX should be able to cover the needs of most OpenGL 1.5 applications. Features are implemented on a per need basis: if a feature is not implemented (or not implemented correctly) the most likely reason is that the OpenGX developers haven't yet encountered an application that they wanted to port that needed it. So, if a missing feature is blocking your adoption of OpenGX, please file an issue; for a faster resolution, providing some code through which the feature can be tested will undoubtedly help.
10+
11+
For a list of implemented functions, please refer to the `src/functions.c` file.
12+
13+
TODO list:
14+
15+
* Implement spotlights
16+
* Complete glGet calls
2717

2818
There are several limitations on the implementation of many features, mostly
2919
due to the hardware. They are detailed in the PDF documentation, but feel free
3020
to file an issue if unsure.
3121

22+
3223
Design documentation
3324
--------------------
3425

@@ -49,3 +40,14 @@ installed, build opengx as follows:
4940
make
5041
# Optional, to install it into devkitPro's portslib:
5142
sudo -E PATH=$PATH make install
43+
44+
45+
Running OpenGX applications in Dolphin
46+
--------------------------------------
47+
48+
OpenGX makes use of some GX features which require changing specific Dolphin settings from their default values:
49+
50+
- Graphics -> Hacks -> Texture Cache -> Accuracy: move it all towards "Safe"
51+
- Graphics -> Hacks -> Embedded Frame Buffer (EFB) -> Uncheck "Store EFB copies to texture only"
52+
- Graphics -> Hacks -> External Frame Buffer (XFB) -> Uncheck "Store XFB copies to texture only"
53+
- Graphics -> Hacks -> Other -> Uncheck "Disable Bounding Box"

0 commit comments

Comments
 (0)