1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/**
* Copyright 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.opengl.util;
import com.jogamp.common.nio.Buffers;
import java.io.File;
import java.io.IOException;
import java.nio.*;
import javax.media.opengl.*;
import com.jogamp.opengl.GLExtensions;
import com.jogamp.opengl.util.texture.Texture;
import com.jogamp.opengl.util.texture.TextureData;
import com.jogamp.opengl.util.texture.TextureIO;
/**
* Utility to read out the current FB to TextureData, optionally writing the data back to a texture object.
* <p>May be used directly to write the TextureData to file (screenshot).</p>
*/
public class GLReadBufferUtil {
protected final int components, alignment;
protected final Texture readTexture;
protected final GLPixelStorageModes psm;
protected int readPixelSizeLast = 0;
protected ByteBuffer readPixelBuffer = null;
protected TextureData readTextureData = null;
/**
* @param alpha true for RGBA readPixels, otherwise RGB readPixels. Disclaimer: Alpha maybe forced on ES platforms!
* @param write2Texture true if readPixel's TextureData shall be written to a 2d Texture
*/
public GLReadBufferUtil(boolean alpha, boolean write2Texture) {
components = alpha ? 4 : 3 ;
alignment = alpha ? 4 : 1 ;
readTexture = write2Texture ? new Texture(GL.GL_TEXTURE_2D) : null ;
psm = new GLPixelStorageModes();
}
public boolean isValid() {
return null!=readTextureData && null!=readPixelBuffer ;
}
public boolean hasAlpha() { return 4 == components ? true : false ; }
public GLPixelStorageModes getGLPixelStorageModes() { return psm; }
/**
* @return the raw pixel ByteBuffer, filled by {@link #readPixels(GLAutoDrawable, boolean)}
*/
public ByteBuffer getPixelBuffer() { return readPixelBuffer; }
/**
* rewind the raw pixel ByteBuffer
*/
public void rewindPixelBuffer() { if( null != readPixelBuffer ) { readPixelBuffer.rewind(); } }
/**
* @return the resulting TextureData, filled by {@link #readPixels(GLAutoDrawable, boolean)}
*/
public TextureData getTextureData() { return readTextureData; }
/**
* @return the Texture object filled by {@link #readPixels(GLAutoDrawable, boolean)},
* if this instance writes to a 2d Texture, otherwise null.
* @see #GLReadBufferUtil(boolean, boolean)
*/
public Texture getTexture() { return readTexture; }
/**
* Write the TextureData filled by {@link #readPixels(GLAutoDrawable, boolean)} to file
*/
public void write(File dest) {
try {
TextureIO.write(readTextureData, dest);
rewindPixelBuffer();
} catch (IOException ex) {
throw new RuntimeException("can not write to file: " + dest.getAbsolutePath(), ex);
}
}
/**
* Read the drawable's pixels to TextureData and Texture, if requested at construction
*
* @param gl the current GL context object. It's read drawable is being used as the pixel source.
* @param drawable the drawable to read from
* @param flip weather to flip the data vertically or not
*
* @see #GLReadBufferUtil(boolean, boolean)
*/
public boolean readPixels(GL gl, boolean flip) {
final int glerr0 = gl.glGetError();
if(GL.GL_NO_ERROR != glerr0) {
System.err.println("Info: GLReadBufferUtil.readPixels: pre-exisiting GL error 0x"+Integer.toHexString(glerr0));
}
final GLDrawable drawable = gl.getContext().getGLReadDrawable();
final int textureInternalFormat, textureDataFormat, textureDataType;
final int[] glImplColorReadVals = new int[] { 0, 0 };
if(gl.isGL2GL3() && 3 == components) {
textureInternalFormat=GL.GL_RGB;
textureDataFormat=GL.GL_RGB;
textureDataType = GL.GL_UNSIGNED_BYTE;
} else if(gl.isGLES2Compatible() || gl.isExtensionAvailable(GLExtensions.OES_read_format)) {
gl.glGetIntegerv(GL.GL_IMPLEMENTATION_COLOR_READ_FORMAT, glImplColorReadVals, 0);
gl.glGetIntegerv(GL.GL_IMPLEMENTATION_COLOR_READ_TYPE, glImplColorReadVals, 1);
textureInternalFormat = (4 == components) ? GL.GL_RGBA : GL.GL_RGB;
textureDataFormat = glImplColorReadVals[0];
textureDataType = glImplColorReadVals[1];
} else {
// RGBA read is safe for all GL profiles
textureInternalFormat = (4 == components) ? GL.GL_RGBA : GL.GL_RGB;
textureDataFormat=GL.GL_RGBA;
textureDataType = GL.GL_UNSIGNED_BYTE;
}
final int tmp[] = new int[1];
final int readPixelSize = GLBuffers.sizeof(gl, tmp, textureDataFormat, textureDataType,
drawable.getWidth(), drawable.getHeight(), 1, true);
boolean newData = false;
if(readPixelSize>readPixelSizeLast) {
readPixelBuffer = Buffers.newDirectByteBuffer(readPixelSize);
readPixelSizeLast = readPixelSize ;
try {
readTextureData = new TextureData(
gl.getGLProfile(),
textureInternalFormat,
drawable.getWidth(), drawable.getHeight(),
0,
textureDataFormat,
textureDataType,
false, false,
flip,
readPixelBuffer,
null /* Flusher */);
newData = true;
} catch (Exception e) {
readTextureData = null;
readPixelBuffer = null;
readPixelSizeLast = 0;
throw new RuntimeException("can not fetch offscreen texture", e);
}
} else {
readTextureData.setInternalFormat(textureInternalFormat);
readTextureData.setWidth(drawable.getWidth());
readTextureData.setHeight(drawable.getHeight());
readTextureData.setPixelFormat(textureDataFormat);
readTextureData.setPixelType(textureDataType);
}
boolean res = null!=readPixelBuffer;
if(res) {
psm.setAlignment(gl, alignment, alignment);
readPixelBuffer.clear();
try {
gl.glReadPixels(0, 0, drawable.getWidth(), drawable.getHeight(), textureDataFormat, textureDataType, readPixelBuffer);
} catch(GLException gle) { res = false; gle.printStackTrace(); }
readPixelBuffer.position(readPixelSize);
readPixelBuffer.flip();
final int glerr1 = gl.glGetError();
if(GL.GL_NO_ERROR != glerr1) {
System.err.println("GLReadBufferUtil.readPixels: readPixels error 0x"+Integer.toHexString(glerr1)+
" "+drawable.getWidth()+"x"+drawable.getHeight()+
", fmt 0x"+Integer.toHexString(textureDataFormat)+", type 0x"+Integer.toHexString(textureDataType)+
", impl-fmt 0x"+Integer.toHexString(glImplColorReadVals[0])+", impl-type 0x"+Integer.toHexString(glImplColorReadVals[1])+
", "+readPixelBuffer+", sz "+readPixelSize);
res = false;
}
if(res && null != readTexture) {
if(newData) {
readTexture.updateImage(gl, readTextureData);
} else {
readTexture.updateSubImage(gl, readTextureData, 0,
0, 0, // src offset
0, 0, // dst offset
drawable.getWidth(), drawable.getHeight());
}
readPixelBuffer.rewind();
}
psm.restore(gl);
}
return res;
}
public void dispose(GL gl) {
if(null != readTexture) {
readTexture.destroy(gl);
readTextureData = null;
}
if(null != readPixelBuffer) {
readPixelBuffer.clear();
readPixelBuffer = null;
}
readPixelSizeLast = 0;
}
}
|
