added wiki and fixed VCT

Author: codex128

.idea/gradle.xml

@@ -4,6 +4,8 @@ Renthyl is a modular FrameGraph-based rendering pipeline designed with efficienc
 
 ## Features
 
+
+
 * Allows for the use of modern rendering paradigms, such as deferred and forward++.
 * Code-first design makes constructing and manipulating FrameGraphs incredibly easy.
 * Easily control the layout of the FrameGraph using game logic.

.idea/inspectionProfiles/Project_Default.xml

@@ -322,7 +322,6 @@ public <T extends RenderModule> T add(T module, int index) {
      * @param inTicket name of the input ticket on each pass
      * @param outTicket name of the output ticket on each pass
      * @return array of passes
-     * @see PassThread#addLoop(T[], int, java.util.function.Supplier, java.lang.String, java.lang.String)
      */
     public <T extends RenderModule> T[] addLoop(T[] array, Function<Integer, T> factory,
             String inTicket, String outTicket) {
@@ -343,7 +342,6 @@ public <T extends RenderModule> T[] addLoop(T[] array, Function<Integer, T> fact
      * @param inTicket name of the input ticket on each pass
      * @param outTicket name of the output ticket on each pass
      * @return array of passes
-     * @see PassThread#addLoop(T[], int, java.util.function.Supplier, java.lang.String, java.lang.String)
      */
     public <T extends RenderModule> T[] addLoop(T[] array, int index,
             Function<Integer, T> function, String inTicket, String outTicket) {
@@ -697,7 +695,7 @@ public boolean isLayoutUpdateNeeded() {
     }
 
     /**
-     * Returns true if this framegraph is running asynchronous {@link PassThread PassThreads}.
+     * Returns true if this framegraph is running asynchronously.
      * 
      * @return 
      */

.idea/markdown.xml

@@ -84,5 +84,14 @@ public boolean isEmpty() {
     public int getIndex() {
         return index;
     }
+
+    /**
+     * Returns true if this job is designated to run on the main application thread.
+     *
+     * @return
+     */
+    public boolean isMainJob() {
+        return index == 0;
+    }
 
 }

.idea/vcs.xml

@@ -68,13 +68,12 @@ public class ResourceView <T> {
     private boolean temporary = false;
     private boolean undefined = false;
 
-    public ResourceView(ResourceUser producer, ResourceDef<T> def, String name, int index/*, ResourceTicket<T> declaringTicket*/) {
+    public ResourceView(ResourceUser producer, ResourceDef<T> def, String name, int index) {
         this.producer = producer;
         this.def = def;
         this.name = name;
         this.index = index;
         this.lifetime = new TimeFrame(this.producer.getIndex(), 0);
-        //declaringTicket.setBindFlag();
     }
 
     /**
@@ -110,9 +109,10 @@ public boolean release(ResourceList list, ResourceTicket ticket) {
         ticket.clearBindFlag();
         if (!writeComplete.getAndSet(true)) {
             if (!readLock.isHeldByCurrentThread()) {
-                throw new IllegalStateException("Read lock not acquired before releasing.");
-            }
-            if (isReadConcurrent()) {
+                if (!complete) { // read lock is only required for shared resources
+                    throw new IllegalStateException("Read lock not acquired before releasing.");
+                }
+            } else if (isReadConcurrent()) {
                 readCondition.signalAll();
             } else {
                 readCondition.signal();

README.md

@@ -32,10 +32,8 @@
 import codex.renthyl.export.NamedTicketIndex;
 import codex.renthyl.export.TicketIndex;
 import codex.renthyl.modules.Connectable;
-import java.util.Iterator;
-import java.util.Collection;
-import java.util.Map;
-import java.util.Objects;
+
+import java.util.*;
 import java.util.function.Consumer;
 
 /**
@@ -49,6 +47,7 @@ public abstract class AbstractTicketGroup <T> implements TicketGroup<T> {
     protected final String name;
     protected Connectable owner;
     private int connectedTickets = 0;
+    private final HashSet<ResourceTicket> ticketSet = new HashSet<>();
 
     public AbstractTicketGroup(String name) {
         this.name = name;
@@ -79,24 +78,27 @@ public ResourceTicket<T> add(String name) {
         return append(new ResourceTicket<>(this, name));
     }
     @Override
-    @SuppressWarnings("null")
-    public int makeInput(TicketGroup<T> source, TicketSelector sourceSelector, TicketSelector targetSelector) {
+    public int makeInput(TicketGroup<T> source, TicketSelector sourceSelector, TicketSelector targetSelector, boolean allowDoubles) {
         int j = 0;
         int connections = 0;
         for (ResourceTicket<T> t : this) {
             if (targetSelector.select(t, j)) {
                 int i = 0;
                 for (ResourceTicket<T> s : source) {
-                    if (sourceSelector.select(s, t, i++) && targetSelector.select(t, s, j)) {
+                    if ((allowDoubles || !ticketSet.contains(s)) && sourceSelector.select(s, t, i) && targetSelector.select(t, s, j)) {
                         t.setSource(s);
-                        System.out.println("connect " + s.getName() + " to " + t.getName());
                         connections++;
+                        if (!allowDoubles) {
+                            ticketSet.add(s);
+                        }
                         break;
                     }
+                    i++;
                 }
             }
             j++;
         }
+        ticketSet.clear();
         if (connections == 0) {
             Renthyl.getInstance().logMissedConnection(sourceSelector, targetSelector);
         }

RenthylCore/src/main/java/codex/renthyl/FrameGraph.java

@@ -85,7 +85,7 @@ public Collection<ResourceTicket<T>> getTickets() {
         return tickets;
     }
     @Override
-    public int makeInput(TicketGroup<T> source, TicketSelector sourceSelector, TicketSelector targetSelector) {
+    public int makeInput(TicketGroup<T> source, TicketSelector sourceSelector, TicketSelector targetSelector, boolean allowDoubles) {
         int i = 0;
         int connections = 0;
         for (ResourceTicket<T> s : source) {