Update README.md
This commit is contained in:
50
README.md
50
README.md
@@ -1,30 +1,31 @@
|
||||
# Josh Graphics Library
|
||||
# Josh's Graphics Library
|
||||
|
||||
Yet Another C++ Rendering Toolkit
|
||||
|
||||

|
||||
[](http://unlicense.org/) 
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* Modern C++ (20)
|
||||
* Provides single-function-calls to render various graphics primitives in 2D and 3D.
|
||||
* Integrates directly with our other toolkits (ReWindow, J3ML)
|
||||
* Quick Rendering of Debug Text, Geometric Widgets, Textures, and so forth.
|
||||
* Little-to-no overhead.
|
||||
* Modern C++ (20).
|
||||
* Cross Platform (Linux & Windows 10 1909 or newer).
|
||||
* Provides single-function-calls to render various graphics in 2D and 3D.
|
||||
* Integrates right into an existing OpenGL rendering system.
|
||||
* Quick Rendering of Text, Shapes, Sprites / Textures, etc.
|
||||
* High-performance text rendering.
|
||||
* Little-to-no overhead.
|
||||
|
||||
## API Overview
|
||||
|
||||
### J2D
|
||||
* DrawPoint
|
||||
* DrawLine / DrawGradientLine
|
||||
* DrawSprite
|
||||
* DrawSprite / DrawPartialSprite
|
||||
* OutlineRect / FillRect / FillGradientRect / FillRoundedRect
|
||||
* OutlineCircle / FillCircle
|
||||
* OutlineTriangle / FillTriangle
|
||||
* DrawString
|
||||
|
||||
### J3D
|
||||
* DrawLine
|
||||
* DrawString
|
||||
@@ -33,14 +34,35 @@ Yet Another C++ Rendering Toolkit
|
||||
* DrawQuaternionGizmo (WIP)
|
||||
|
||||
### Types
|
||||
* RenderTarget
|
||||
* VRamList
|
||||
* Texture
|
||||
* Font
|
||||
* Sprite
|
||||
* Color4/Color3
|
||||
* Gradient
|
||||
|
||||
## Usage
|
||||
```cpp
|
||||
// Makes sure the glViewport will be the correct size.
|
||||
// Typically done once per frame.
|
||||
JGL::Update(window_size);
|
||||
|
||||
Install instructions and code samples coming soon :tm: !
|
||||
JGL::J2D::Begin();
|
||||
JGL::J2D::FillRect(Colors::Blue, {0,0}, {16,16});
|
||||
JGL::J2D::End();
|
||||
|
||||
// See the example program in main.cpp for more in-depth usage.
|
||||
```
|
||||
## Requirements
|
||||
|
||||
An OpenGL 2.1 or newer accelerator that supports the `GL_ARB_framebuffer_object` extension or
|
||||
an implementation that can provide those features through alternative means (common on ArmSoC and Risc-V).
|
||||
|
||||
## Compatability
|
||||
|
||||
* AMD ✓
|
||||
* NVIDIA ✓
|
||||
* Intel ✓
|
||||
* Zink (OpenGL-on-Vulkan) ✓
|
||||
* GL4ES ✓
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -50,10 +72,6 @@ Documentation is (sic: will be) automatically generated from latest commit and i
|
||||
|
||||
Contributions to JGL are welcome! If you find a bug, have a feature request, or would like to contribute code, please submit an issue or pull request to our repository!
|
||||
|
||||
## License
|
||||
|
||||
JGL is licensed under the Public Domain. See the LICENSE file for details.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
JGL is developed and maintained by Josh O'Leary @ Co from Redacted Software and contributors. Special thanks to Redacted.
|
Reference in New Issue
Block a user