You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/API_DOCS.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Developer API documentation
2
2
3
-
###Including ImmediatelyFast using Gradle
3
+
## Including ImmediatelyFast using Gradle
4
4
To use ImmediatelyFast with Gradle you can use the Modrinth maven server:
5
5
```groovy
6
6
repositories {
@@ -12,8 +12,15 @@ dependencies {
12
12
}
13
13
```
14
14
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
+
15
25
### Main API class
16
26
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