Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
douira committed Nov 7, 2023
1 parent ac3d1de commit 3e83520
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
import me.jellysquid.mods.sodium.client.render.chunk.gfni.TranslucentSorting.SectionTriggers;
import net.minecraft.util.math.ChunkSectionPos;

/**
* Performs direct triggering for sections that can't (or shouldn't) be
* topologically sorted and thus aren't eligible for GFNI triggering.
*/
class DirectTriggers implements SectionTriggers {
/**
* A tree map of the directly triggered sections, indexed by their
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
import me.jellysquid.mods.sodium.client.render.chunk.gfni.TranslucentSorting.SectionTriggers;
import net.minecraft.util.math.ChunkSectionPos;

/**
* Performs Global Face Normal Indexing-based triggering as described in
* https://hackmd.io/@douira100/sodium-sl-gfni
*/
class GFNITriggers implements SectionTriggers {
/**
* A map of all the normal lists, indexed by their normal.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
import net.minecraft.util.math.ChunkSectionPos;

/**
* Global Face Normal Indexing as described in
* https://hackmd.io/@douira100/sodium-sl-gfni
* This class is the central point in translucency sorting. It counts the number
* of translucent data objects for each sort type and delegates triggering of
* sections for dynamic sorting to the trigger components.
*
* Distances are stored as doubles and normals are stored as float vectors.
*
Expand Down

0 comments on commit 3e83520

Please sign in to comment.