Add IDhApiGenericObjectShaderProgram

2024-07-11 16:35:38 -05:00
parent ef3cd4b43d
commit 116df0d999
5 changed files with 348 additions and 262 deletions
@@ -0,0 +1,78 @@
+/*
+ *    This file is part of the Distant Horizons mod
+ *    licensed under the GNU LGPL v3 License.
+ *
+ *    Copyright (C) 2020-2023 James Seibel
+ *
+ *    This program is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU Lesser General Public License as published by
+ *    the Free Software Foundation, version 3.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public License
+ *    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.seibel.distanthorizons.api.interfaces.override.rendering;
+
+import com.seibel.distanthorizons.api.interfaces.override.IDhApiOverrideable;
+import com.seibel.distanthorizons.api.interfaces.render.IDhApiRenderableBoxGroup;
+import com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhApiRenderParam;
+import com.seibel.distanthorizons.api.objects.math.DhApiVec3d;
+import com.seibel.distanthorizons.api.objects.render.DhApiRenderableBox;
+import com.seibel.distanthorizons.api.objects.render.DhApiRenderableBoxGroupShading;
+
+/**
+ * @author James Seibel
+ * @version 2024-7-11
+ * @since API 3.0.0
+ */
+public interface IDhApiGenericObjectShaderProgram extends IDhApiOverrideable
+{
+	
+	/**
+	 * If this method is called that means this program has the highest priority as defined by {@link IDhApiOverrideable#getPriority()}
+	 * and gets to decide if it wants to be used to render this frame or not. <br><br>
+	 *
+	 * If this method returns true then this program will be used for this frame. <br>
+	 * If this returns false then the default DH {@link IDhApiGenericObjectShaderProgram} will be used instead.
+	 */
+	boolean overrideThisFrame();
+	
+	/** @return the OpenGL ID for this shader program */
+	int getId();
+	
+	/** Free any OpenGL objects owned by this program. */
+	void free();
+	
+	/** Runs any necessary binding this program needs so rendering can be done. */
+	void bind();
+	/** Runs any necessary unbinding this program needs so rendering can be done by another program. */
+	void unbind();
+	
+	/** Binds the given Vertex Buffer Object to this shader program for rendering. */
+	void bindVertexBuffer(int vbo);
+	
+	
+	/** sets up the necessary uniforms for rendering */
+	void fillIndirectUniformData(
+			DhApiRenderParam renderParameters,
+			DhApiRenderableBoxGroupShading shading, IDhApiRenderableBoxGroup boxGroup, 
+			DhApiVec3d camPos);
+	
+	/** sets up the necessary uniforms for rendering */
+	void fillSharedDirectUniformData(
+			DhApiRenderParam renderParameters,
+			DhApiRenderableBoxGroupShading shading, IDhApiRenderableBoxGroup boxGroup, 
+			DhApiVec3d camPos);
+	void fillDirectUniformData(
+			DhApiRenderParam renderParameters,
+			IDhApiRenderableBoxGroup boxGroup, DhApiRenderableBox box,
+			DhApiVec3d camPos);
+	
+	
+}