Fiddle with README some
Some checks failed
Run ReCI Build Test / Explore-Gitea-Actions (push) Failing after 2m37s
Some checks failed
Run ReCI Build Test / Explore-Gitea-Actions (push) Failing after 2m37s
This commit is contained in:
40
README.md
40
README.md
@@ -4,23 +4,39 @@ Yet Another C++ Rendering Toolkit
|
||||
|
||||

|
||||
|
||||
## Goals
|
||||
* Provide single-function-calls to render various graphics primitives in 2D and 3D.
|
||||
* Integrated directly with our other toolkits (ReWindow, J3ML)
|
||||
* Quick Rendering of Debug Text, Geometric Widgets, Textures, and so forth.
|
||||
|
||||
## Non-Goals
|
||||
* Full Rendering Engine
|
||||
* OpenGL/Vulkan Wrapper
|
||||
* Asset Loading & Management
|
||||
|
||||
## Features
|
||||
|
||||
* Modern C++ (20)
|
||||
* Little-to-no overhead
|
||||
* No hand-holding
|
||||
* No-frills, straight up just renders shapes and text.
|
||||
* 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.
|
||||
* Integrates right into an existing OpenGL rendering system.
|
||||
* High-performance text rendering.
|
||||
|
||||
## API Overview
|
||||
|
||||
### J2D
|
||||
* DrawPixel
|
||||
* DrawLine / DrawGradientLine
|
||||
* DrawSprite
|
||||
* OutlineRect / FillRect / FillGradientRect / FillRoundedRect
|
||||
* OutlineCircle / FillCircle
|
||||
* OutlineTriangle / FillTriangle
|
||||
* DrawString
|
||||
### J3D
|
||||
* DrawLine
|
||||
* DrawString
|
||||
* DrawMatrixGizmo (WIP)
|
||||
* DrawAxisAngleGizmo (WIP)
|
||||
* DrawQuaternionGizmo (WIP)
|
||||
|
||||
### Types
|
||||
* Font
|
||||
* Sprite
|
||||
* Color4/Color3
|
||||
* Gradient
|
||||
|
||||
## Usage
|
||||
|
||||
|
Reference in New Issue
Block a user