diff options
| author | makamys <makamys@outlook.com> | 2022-06-09 13:12:07 +0200 |
|---|---|---|
| committer | makamys <makamys@outlook.com> | 2022-06-09 13:13:24 +0200 |
| commit | dd14fdbec57d9953fc9a7484c74af32809ccc94e (patch) | |
| tree | ad2008888d71ba05015e985265f4aa77961fb579 /src/main | |
| parent | 87f7580262e4667105e71af50ca837b9b66bd22a (diff) | |
| download | Neodymium-dd14fdbec57d9953fc9a7484c74af32809ccc94e.tar.gz Neodymium-dd14fdbec57d9953fc9a7484c74af32809ccc94e.tar.bz2 Neodymium-dd14fdbec57d9953fc9a7484c74af32809ccc94e.zip | |
Add javadoc for some key classes
Diffstat (limited to 'src/main')
5 files changed, 5 insertions, 0 deletions
diff --git a/src/main/java/makamys/neodymium/renderer/ChunkMesh.java b/src/main/java/makamys/neodymium/renderer/ChunkMesh.java index 6d5dc2d..4f805e3 100644 --- a/src/main/java/makamys/neodymium/renderer/ChunkMesh.java +++ b/src/main/java/makamys/neodymium/renderer/ChunkMesh.java @@ -28,6 +28,7 @@ import net.minecraft.nbt.NBTBase; import net.minecraft.nbt.NBTTagByteArray; import net.minecraft.tileentity.TileEntity; +/** A mesh for a 16x16x16 region of the world. */ public class ChunkMesh extends Mesh { Flags flags; diff --git a/src/main/java/makamys/neodymium/renderer/GPUMemoryManager.java b/src/main/java/makamys/neodymium/renderer/GPUMemoryManager.java index 1bb2623..d4c3b92 100644 --- a/src/main/java/makamys/neodymium/renderer/GPUMemoryManager.java +++ b/src/main/java/makamys/neodymium/renderer/GPUMemoryManager.java @@ -10,6 +10,7 @@ import makamys.neodymium.Neodymium; import makamys.neodymium.renderer.Mesh.GPUStatus; import makamys.neodymium.util.GuiHelper; +/** Manages dynamic memory allocation inside a fixed buffer on the GPU. */ public class GPUMemoryManager { private int bufferSize; diff --git a/src/main/java/makamys/neodymium/renderer/Mesh.java b/src/main/java/makamys/neodymium/renderer/Mesh.java index dea5fc1..4c88f52 100644 --- a/src/main/java/makamys/neodymium/renderer/Mesh.java +++ b/src/main/java/makamys/neodymium/renderer/Mesh.java @@ -7,6 +7,7 @@ import makamys.neodymium.util.Util; import net.minecraft.entity.Entity; import net.minecraft.nbt.NBTBase; +/** A generic mesh that can be sent to the GPU for rendering. */ public abstract class Mesh { /** Can be null, unless gpuStatus is SENT */ diff --git a/src/main/java/makamys/neodymium/renderer/NeoChunk.java b/src/main/java/makamys/neodymium/renderer/NeoChunk.java index 1184d84..9bbe361 100644 --- a/src/main/java/makamys/neodymium/renderer/NeoChunk.java +++ b/src/main/java/makamys/neodymium/renderer/NeoChunk.java @@ -9,6 +9,7 @@ import net.minecraft.nbt.NBTTagEnd; import net.minecraft.nbt.NBTTagList; import net.minecraft.world.chunk.Chunk; +/** A container for the meshes that compose a chunk (16x256x16 region). It keeps track of which meshes should be made visible and which ones should not. */ public class NeoChunk { int x, z; diff --git a/src/main/java/makamys/neodymium/renderer/NeoRenderer.java b/src/main/java/makamys/neodymium/renderer/NeoRenderer.java index 708a9db..b162ead 100644 --- a/src/main/java/makamys/neodymium/renderer/NeoRenderer.java +++ b/src/main/java/makamys/neodymium/renderer/NeoRenderer.java @@ -52,6 +52,7 @@ import static org.lwjgl.opengl.GL15.*; import static org.lwjgl.opengl.GL20.*; import static org.lwjgl.opengl.GL30.*; +/** The main renderer class. */ public class NeoRenderer { public boolean hasInited = false; |