Skip to content

Commit 8ad9044

Browse files
committed
Updated API_DOCS.md
1 parent 7f50142 commit 8ad9044

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/API_DOCS.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Developer API documentation
22

3-
### Including ImmediatelyFast using Gradle
3+
## Including ImmediatelyFast using Gradle
44
To use ImmediatelyFast with Gradle you can use the Modrinth maven server:
55
```groovy
66
repositories {
@@ -12,8 +12,15 @@ dependencies {
1212
}
1313
```
1414

15+
## Main Class
16+
The main class is ``net.raphimc.immediatelyfast.ImmediatelyFast``. It holds the currently loaded config, runtime config and the version of the mod.
17+
18+
## Batching
19+
ImmediatelyFast batches HUD rendering by default. If your mod only renders HUD elements, you don't need to do anything, because ImmediatelyFast will automatically batch your HUD elements.
20+
21+
To manually batch some of your rendering code, you can use the ``BatchingBuffers`` class. Simply wrap your code in ``BatchingBuffers.runBatched`` and it will be batched.
22+
23+
## Old API
24+
1525
### Main API class
1626
The main API class is ``net.raphimc.immediatelyfastapi.ImmediatelyFastApi``. It contains access to the batching system and the currently loaded config.
17-
18-
### Accessing internals
19-
While it is not recommended to access internals of ImmediatelyFast you can do so by using classes in the ``net.raphimc.immediatelyfast`` package. These classes are not guaranteed to be stable and may change at any time, so make sure to build your code in a fail-safe manner if you decide to use them.

0 commit comments

Comments
 (0)