/src/main/java/org/distorted/library/main/DistortedFramebuffer.java - Annotate - Distorted Android

library / src / main / java / org / distorted / library / main / DistortedFramebuffer.java @ 88c7b603

1	f6fb3c6d	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
2			// Copyright 2016 Leszek Koltunski //
3			// //
4			// This file is part of Distorted. //
5			// //
6			// Distorted is free software: you can redistribute it and/or modify //
7			// it under the terms of the GNU General Public License as published by //
8			// the Free Software Foundation, either version 2 of the License, or //
9			// (at your option) any later version. //
10			// //
11			// Distorted is distributed in the hope that it will be useful, //
12			// but WITHOUT ANY WARRANTY; without even the implied warranty of //
13			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
14			// GNU General Public License for more details. //
15			// //
16			// You should have received a copy of the GNU General Public License //
17			// along with Distorted. If not, see <http://www.gnu.org/licenses/>. //
18			///////////////////////////////////////////////////////////////////////////////////////////////////
19
20	fe82a979	Leszek Koltunski	package org.distorted.library.main;
21	f6fb3c6d	Leszek Koltunski
22	e6519ac8	Leszek Koltunski	import android.opengl.GLES31;
23	f6fb3c6d	Leszek Koltunski
24			///////////////////////////////////////////////////////////////////////////////////////////////////
25	dedacd82	Leszek Koltunski	/**
26			* Class which represents a OpenGL Framebuffer object.
27	71c3fecc	Leszek Koltunski	* <p>
28	c5369f1b	leszek	* User is able to create offscreen FBOs and both a) render to them b) use their COLOR0 attachment as
29	2ed1c692	leszek	* an input texture. Attaching Depths and/or Stencils is also possible.
30	dedacd82	Leszek Koltunski	*/
31	af4cc5db	Leszek Koltunski	public class DistortedFramebuffer extends DistortedOutputSurface implements DistortedInputSurface
32	f6fb3c6d	Leszek Koltunski	{
33	bd3da5b2	Leszek Koltunski
34	f6fb3c6d	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
35	6537ba91	Leszek Koltunski	// Must be called from a thread holding OpenGL Context
36	f6fb3c6d	Leszek Koltunski
37	2f35828c	Leszek Koltunski	void create()
38	f6fb3c6d	Leszek Koltunski	{
39	c7da4e65	leszek	if( mColorCreated==NOT_CREATED_YET )
40	7cf783cb	Leszek Koltunski	{
41	e6519ac8	Leszek Koltunski	GLES31.glGenTextures( mNumColors, mColorH, 0);
42			GLES31.glGenFramebuffers(1, mFBOH, 0);
43			GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, mFBOH[0]);
44	9ed80185	Leszek Koltunski
45			for(int i=0; i<mNumColors; i++)
46			{
47	e6519ac8	Leszek Koltunski	GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, mColorH[i]);
48			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_WRAP_S, GLES31.GL_REPEAT);
49			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_WRAP_T, GLES31.GL_REPEAT);
50			GLES31.glTexParameterf(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_MIN_FILTER, GLES31.GL_NEAREST);
51			GLES31.glTexParameterf(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_MAG_FILTER, GLES31.GL_LINEAR);
52	a4b182d4	Leszek Koltunski	GLES31.glTexImage2D(GLES31.GL_TEXTURE_2D, 0, GLES31.GL_RGBA, mRealWidth, mRealHeight, 0, GLES31.GL_RGBA, GLES31.GL_UNSIGNED_BYTE, null);
53	9ed80185	Leszek Koltunski	}
54	e6519ac8	Leszek Koltunski	GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, mColorH[0], 0);
55			GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, 0);
56			GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, 0);
57	dedacd82	Leszek Koltunski
58	c7da4e65	leszek	mColorCreated = checkStatus("color");
59	7cf783cb	Leszek Koltunski	}
60	89de975c	leszek	if( mDepthStencilCreated==NOT_CREATED_YET ) // we need to create a new DEPTH or STENCIL attachment
61	8c327653	Leszek Koltunski	{
62	e6519ac8	Leszek Koltunski	GLES31.glGenTextures(1, mDepthStencilH, 0);
63			GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, mDepthStencilH[0]);
64			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_WRAP_S, GLES31.GL_REPEAT);
65			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_WRAP_T, GLES31.GL_REPEAT);
66			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_MIN_FILTER, GLES31.GL_NEAREST);
67			GLES31.glTexParameteri(GLES31.GL_TEXTURE_2D, GLES31.GL_TEXTURE_MAG_FILTER, GLES31.GL_NEAREST);
68	8c327653	Leszek Koltunski
69	89de975c	leszek	if( mDepthStencil==DEPTH_NO_STENCIL )
70	65e83759	Leszek Koltunski	{
71	a4b182d4	Leszek Koltunski	GLES31.glTexImage2D(GLES31.GL_TEXTURE_2D, 0, GLES31.GL_DEPTH_COMPONENT, mRealWidth, mRealHeight, 0, GLES31.GL_DEPTH_COMPONENT, GLES31.GL_UNSIGNED_INT, null);
72	65e83759	Leszek Koltunski	}
73	89de975c	leszek	else if( mDepthStencil==BOTH_DEPTH_STENCIL )
74	65e83759	Leszek Koltunski	{
75	a4b182d4	Leszek Koltunski	GLES31.glTexImage2D(GLES31.GL_TEXTURE_2D, 0, GLES31.GL_DEPTH24_STENCIL8, mRealWidth, mRealHeight, 0, GLES31.GL_DEPTH_STENCIL, GLES31.GL_UNSIGNED_INT_24_8, null);
76	65e83759	Leszek Koltunski	}
77	89de975c	leszek
78	e6519ac8	Leszek Koltunski	GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, 0);
79			GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, mFBOH[0]);
80	8c327653	Leszek Koltunski
81	89de975c	leszek	if( mDepthStencil==DEPTH_NO_STENCIL )
82	65e83759	Leszek Koltunski	{
83	e6519ac8	Leszek Koltunski	GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_DEPTH_ATTACHMENT, GLES31.GL_TEXTURE_2D, mDepthStencilH[0], 0);
84	65e83759	Leszek Koltunski	}
85	89de975c	leszek	else if( mDepthStencil==BOTH_DEPTH_STENCIL )
86	65e83759	Leszek Koltunski	{
87	e6519ac8	Leszek Koltunski	GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_DEPTH_STENCIL_ATTACHMENT, GLES31.GL_TEXTURE_2D, mDepthStencilH[0], 0);
88	65e83759	Leszek Koltunski	}
89	89de975c	leszek
90	e6519ac8	Leszek Koltunski	GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, 0);
91	89de975c	leszek
92			mDepthStencilCreated = checkStatus("depth");
93	8c327653	Leszek Koltunski	}
94	89de975c	leszek	if( mDepthStencilCreated==DONT_CREATE && mDepthStencilH[0]>0 ) // we need to detach and recreate the DEPTH attachment.
95	8c327653	Leszek Koltunski	{
96	68f96a01	leszek	// OpenGL ES 3.0.5 spec, chapter 4.4.2.4 :
97			// "Note that the texture image is specifically not detached from any other framebuffer objects.
98			// Detaching the texture image from any other framebuffer objects is the responsibility of the application."
99	e6519ac8	Leszek Koltunski	GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, mFBOH[0]);
100			GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_DEPTH_ATTACHMENT , GLES31.GL_TEXTURE_2D, 0, 0);
101			GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_DEPTH_STENCIL_ATTACHMENT, GLES31.GL_TEXTURE_2D, 0, 0);
102			GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, 0);
103	75f95f8d	leszek
104	e6519ac8	Leszek Koltunski	GLES31.glDeleteTextures(1, mDepthStencilH, 0);
105	89de975c	leszek	mDepthStencilH[0]=0;
106	8c327653	Leszek Koltunski	}
107	8337fa41	Leszek Koltunski	}
108
109			///////////////////////////////////////////////////////////////////////////////////////////////////
110
111	c7da4e65	leszek	private int checkStatus(String message)
112	8337fa41	Leszek Koltunski	{
113	e6519ac8	Leszek Koltunski	int status = GLES31.glCheckFramebufferStatus(GLES31.GL_FRAMEBUFFER);
114	8337fa41	Leszek Koltunski
115	e6519ac8	Leszek Koltunski	if(status != GLES31.GL_FRAMEBUFFER_COMPLETE)
116	8337fa41	Leszek Koltunski	{
117			android.util.Log.e("DistortedFramebuffer", "FRAMEBUFFER INCOMPLETE, "+message+" error="+status);
118
119	e6519ac8	Leszek Koltunski	GLES31.glDeleteTextures(1, mColorH, 0);
120			GLES31.glDeleteTextures(1, mDepthStencilH, 0);
121			GLES31.glDeleteFramebuffers(1, mFBOH, 0);
122	c7da4e65	leszek	mFBOH[0]= 0;
123	8337fa41	Leszek Koltunski
124	c7da4e65	leszek	return FAILED_TO_CREATE;
125	8337fa41	Leszek Koltunski	}
126	8c327653	Leszek Koltunski
127	c7da4e65	leszek	return CREATED;
128	f6fb3c6d	Leszek Koltunski	}
129
130			///////////////////////////////////////////////////////////////////////////////////////////////////
131	6537ba91	Leszek Koltunski	// Must be called from a thread holding OpenGL Context
132	f6fb3c6d	Leszek Koltunski
133	2f35828c	Leszek Koltunski	void delete()
134	f6fb3c6d	Leszek Koltunski	{
135	c7da4e65	leszek	if( mColorH[0]>0 )
136	e6cf7d50	Leszek Koltunski	{
137	e6519ac8	Leszek Koltunski	GLES31.glDeleteTextures(1, mColorH, 0);
138	c7da4e65	leszek	mColorH[0] = 0;
139			mColorCreated = NOT_CREATED_YET;
140	5b959cc5	Leszek Koltunski	}
141	bd3da5b2	Leszek Koltunski
142	5b959cc5	Leszek Koltunski	if( mDepthStencilH[0]>0 )
143			{
144	e6519ac8	Leszek Koltunski	GLES31.glDeleteTextures(1, mDepthStencilH, 0);
145	5b959cc5	Leszek Koltunski	mDepthStencilH[0]=0;
146			mDepthStencilCreated = NOT_CREATED_YET;
147	e6cf7d50	Leszek Koltunski	}
148	5b959cc5	Leszek Koltunski
149	e6519ac8	Leszek Koltunski	GLES31.glDeleteFramebuffers(1, mFBOH, 0);
150	5b959cc5	Leszek Koltunski	mFBOH[0] = 0;
151	bd3da5b2	Leszek Koltunski	}
152
153	4ebbb17a	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
154			// called from onDestroy(); mark OpenGL assets as 'not created'
155
156	2f35828c	Leszek Koltunski	void recreate()
157	4ebbb17a	Leszek Koltunski	{
158	05ecc6fe	Leszek Koltunski	if( mColorCreated!=DONT_CREATE )
159			{
160			mColorCreated = NOT_CREATED_YET;
161			mColorH[0] = 0;
162			}
163	89de975c	leszek	if( mDepthStencilCreated!=DONT_CREATE )
164	05ecc6fe	Leszek Koltunski	{
165	89de975c	leszek	mDepthStencilCreated = NOT_CREATED_YET;
166			mDepthStencilH[0] = 0;
167	05ecc6fe	Leszek Koltunski	}
168	4ebbb17a	Leszek Koltunski	}
169
170	af27df87	leszek	///////////////////////////////////////////////////////////////////////////////////////////////////
171	09ab7524	Leszek Koltunski	// create SYSTEM or TREE framebuffers (those are just like normal FBOs, just hold information
172			// that they were autocreated only for the Library's internal purposes (SYSTEM) or for using
173			// inside a Tree of DistortedNodes (TREE)
174			// SYSTEM surfaces do not get removed in onDestroy().
175	af27df87	leszek
176	9ed80185	Leszek Koltunski	DistortedFramebuffer(int numcolors, int depthStencil, int type, int width, int height)
177	af27df87	leszek	{
178	9ed80185	Leszek Koltunski	super(width,height,NOT_CREATED_YET,numcolors,depthStencil,NOT_CREATED_YET, type);
179	af27df87	leszek	}
180
181	f6fb3c6d	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
182			// PUBLIC API
183	dedacd82	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
184	cdd5e827	Leszek Koltunski	/**
185	9ed80185	Leszek Koltunski	* Create new offscreen Framebuffer with configurable number of COLOR, DEPTH and STENCIL attachments.
186	cdd5e827	Leszek Koltunski	*
187	9ed80185	Leszek Koltunski	* @param width Width of all the COLOR attachments.
188			* @param height Height of all the COLOR attachments.
189			* @param numcolors How many COLOR attachments to create?
190	89de975c	leszek	* @param depthStencil Add DEPTH or STENCIL attachment?
191	23eecbd9	Leszek Koltunski	* Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.
192	cdd5e827	Leszek Koltunski	*/
193			@SuppressWarnings("unused")
194	9ed80185	Leszek Koltunski	public DistortedFramebuffer(int width, int height, int numcolors, int depthStencil)
195	cdd5e827	Leszek Koltunski	{
196	9ed80185	Leszek Koltunski	super(width,height,NOT_CREATED_YET,numcolors,depthStencil,NOT_CREATED_YET,TYPE_USER);
197	cdd5e827	Leszek Koltunski	}
198
199	133cbb2b	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
200
201	dedacd82	Leszek Koltunski	/**
202	9ed80185	Leszek Koltunski	* Create new offscreen Framebuffer with COLOR0 attachment only.
203	dedacd82	Leszek Koltunski	*
204	9ed80185	Leszek Koltunski	* @param width Width of the COLOR0 attachment.
205			* @param height Height of the COLOR0 attachment.
206	dedacd82	Leszek Koltunski	*/
207	1942537e	Leszek Koltunski	@SuppressWarnings("unused")
208	ed13a5de	Leszek Koltunski	public DistortedFramebuffer(int width, int height)
209	f6fb3c6d	Leszek Koltunski	{
210	9ed80185	Leszek Koltunski	super(width,height,NOT_CREATED_YET, 1, NO_DEPTH_NO_STENCIL,NOT_CREATED_YET,TYPE_USER);
211	f6fb3c6d	Leszek Koltunski	}
212
213	b448e6b9	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
214	dedacd82	Leszek Koltunski	/**
215	c5369f1b	leszek	* Bind the underlying rectangle of pixels as a OpenGL Texture.
216	af4cc5db	Leszek Koltunski	*
217	a436ccc5	leszek	* @return <code>true</code> if successful.
218	dedacd82	Leszek Koltunski	*/
219	c5369f1b	leszek	public boolean setAsInput()
220	b448e6b9	Leszek Koltunski	{
221	c5369f1b	leszek	if( mColorH[0]>0 )
222			{
223	e6519ac8	Leszek Koltunski	GLES31.glActiveTexture(GLES31.GL_TEXTURE0);
224			GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, mColorH[0]);
225	c5369f1b	leszek	return true;
226			}
227
228			return false;
229			}
230	2e49718d	Leszek Koltunski
231	1dfc9074	leszek	///////////////////////////////////////////////////////////////////////////////////////////////////
232			/**
233			* Bind the underlying rectangle of pixels as a OpenGL Texture.
234			*
235			* @return <code>true</code> if successful.
236			*/
237			public boolean setAsInput(int texture)
238			{
239			if( texture>=0 && texture<mNumColors && mColorH[texture]>0 )
240			{
241	e6519ac8	Leszek Koltunski	GLES31.glActiveTexture(GLES31.GL_TEXTURE0);
242			GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, mColorH[texture]);
243	1dfc9074	leszek	return true;
244			}
245
246			return false;
247			}
248
249			///////////////////////////////////////////////////////////////////////////////////////////////////
250
251			public void bindForOutput(int texture)
252			{
253			if( texture>=0 && texture<mNumColors && mColorH[texture]>0 )
254			{
255	e6519ac8	Leszek Koltunski	GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, mColorH[texture], 0);
256	1dfc9074	leszek	}
257			}
258
259	89de975c	leszek	///////////////////////////////////////////////////////////////////////////////////////////////////
260			/**
261			* Enable.disable DEPTH and STENCIL buffers.
262			*
263	23eecbd9	Leszek Koltunski	* @param depthStencil Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.
264	89de975c	leszek	*/
265			public void enableDepthStencil(int depthStencil)
266			{
267	65e83759	Leszek Koltunski	if( depthStencil != mDepthStencil )
268	89de975c	leszek	{
269			mDepthStencil = depthStencil;
270
271	65e83759	Leszek Koltunski	if( depthStencil!= NO_DEPTH_NO_STENCIL && mDepthStencilCreated==DONT_CREATE )
272	89de975c	leszek	{
273	65e83759	Leszek Koltunski	mDepthStencilCreated = NOT_CREATED_YET;
274			markForCreation();
275	89de975c	leszek	}
276	65e83759	Leszek Koltunski	if( depthStencil== NO_DEPTH_NO_STENCIL && mDepthStencilCreated!=DONT_CREATE )
277			{
278			mDepthStencilCreated = DONT_CREATE;
279			markForCreation();
280			}
281	89de975c	leszek	}
282			}
283
284	d1e740c5	Leszek Koltunski	///////////////////////////////////////////////////////////////////////////////////////////////////
285			/**
286	09d4f4b1	Leszek Koltunski	* Return the ID of the Texture (COLOR attachment 0) that's backing this FBO.
287			* <p>
288			* Catch: this will only work if the library has had time to actually create the texture. Remember
289			* that the texture gets created only on first render, thus creating a Texture object and immediately
290			* calling this method will return an invalid (negative) result.
291			*
292	ab12f06b	Leszek Koltunski	* @return If there was not a single render between creation of the Object and calling this method on
293			* it, return a negative value. Otherwise, return ID of COLOR attachment 0.
294	d1e740c5	Leszek Koltunski	*/
295	09d4f4b1	Leszek Koltunski	public int getTextureID()
296	d1e740c5	Leszek Koltunski	{
297	133cbb2b	Leszek Koltunski	return mColorH[0];
298	8c327653	Leszek Koltunski	}
299	f6fb3c6d	Leszek Koltunski	}

Project

General

Profile

Distorted Android

library / src / main / java / org / distorted / library / main / DistortedFramebuffer.java @ 88c7b603