aboutsummaryrefslogtreecommitdiffstats
path: root/src/classes/com/sun/opengl/impl/windows/wgl/WindowsPbufferWGLDrawable.java
blob: a13592d621a04d5cdd1be04f09a33e6e48901cd3 (plain)
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution 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.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.sun.opengl.impl.windows.wgl;

import javax.media.opengl.*;
import com.sun.opengl.impl.*;

public class WindowsPbufferWGLDrawable extends WindowsWGLDrawable {
  private long cachedParentHdc;
  private WGLExt cachedWGLExt; // cached WGLExt instance from parent GLCanvas,
                               // needed to destroy pbuffer
  private long buffer; // pbuffer handle

  private int floatMode;

  public WindowsPbufferWGLDrawable(GLDrawableFactory factory,
                                   GLCapabilities requestedCapabilities,
                                   int width,
                                   int height,
                                   WindowsWGLDrawable dummyDrawable,
                                   WGLExt wglExt) {
    super(factory, new NullWindow(), true, requestedCapabilities, null);
    if (width <= 0 || height <= 0) {
      throw new GLException("Width and height of pbuffer must be positive (were (" +
			    width + ", " + height + "))");
    }
    NullWindow nw = (NullWindow) getNativeWindow();
    nw.setSize(width, height);

    if (DEBUG) {
      System.out.println("Pbuffer caps on init: " + requestedCapabilities +
                         (requestedCapabilities.getPbufferRenderToTexture() ? " [rtt]" : "") +
                         (requestedCapabilities.getPbufferRenderToTextureRectangle() ? " [rect]" : "") +
                         (requestedCapabilities.getPbufferFloatingPointBuffers() ? " [float]" : ""));
    }

    createPbuffer(dummyDrawable.getNativeWindow().getSurfaceHandle(), wglExt);
  }

  public GLContext createContext(GLContext shareWith) {
    return new WindowsPbufferWGLContext(this, shareWith);
  }

  public void destroy() {
    NullWindow nw = (NullWindow) getNativeWindow();
    if (nw.getSurfaceHandle() != 0) {
      // Must release DC and pbuffer
      // NOTE that since the context is not current, glGetError() can
      // not be called here, so we skip the use of any composable
      // pipelines (see WindowsOnscreenWGLContext.makeCurrentImpl)
      WGLExt wglExt = cachedWGLExt;
      if (wglExt.wglReleasePbufferDC(buffer, nw.getSurfaceHandle()) == 0) {
        throw new GLException("Error releasing pbuffer device context: error code " + WGL.GetLastError());
      }
      nw.setSurfaceHandle(0);
      if (!wglExt.wglDestroyPbuffer(buffer)) {
        throw new GLException("Error destroying pbuffer: error code " + WGL.GetLastError());
      }
      buffer = 0;
      setChosenGLCapabilities(null);
    }
    super.destroy();
  }

  public long getPbuffer() {
    return buffer;
  }

  public int getFloatingPointMode() {
    return floatMode;
  }

  public void swapBuffers() throws GLException {
    // FIXME: this doesn't make sense any more because we don't have
    // access to our OpenGL context here
    /*
    // FIXME: do we need to do anything if the pbuffer is double-buffered?
    // For now, just grab the pixels for the render-to-texture support.
    if (rtt && !hasRTT) {
      if (DEBUG) {
        System.err.println("Copying pbuffer data to GL_TEXTURE_2D state");
      }

      GL gl = getGL();
      gl.glCopyTexSubImage2D(textureTarget, 0, 0, 0, 0, 0, width, height);
    }
    */
  }

  // This is public to allow access from PbufferContext
  public GLCapabilities getRequestedGLCapabilities() {
    return super.getRequestedGLCapabilities();
  }

  private void createPbuffer(long parentHdc, WGLExt wglExt) {
    int[]   iattributes = new int  [2*MAX_ATTRIBS];
    float[] fattributes = new float[1];
    int[]   floatModeTmp = new int[1];
    int     niattribs   = 0;
    int     width, height;

    GLCapabilities capabilities = getRequestedGLCapabilities();

    if (DEBUG) {
      System.out.println("Pbuffer parentHdc = " + toHexString(parentHdc));
      System.out.println("Pbuffer caps: " + capabilities +
                         (capabilities.getPbufferRenderToTexture() ? " [rtt]" : "") +
                         (capabilities.getPbufferRenderToTextureRectangle() ? " [rect]" : "") +
                         (capabilities.getPbufferFloatingPointBuffers() ? " [float]" : ""));
    }

    if (!glCapabilities2iattributes(capabilities,
                                    iattributes,
                                    wglExt,
                                    true,
                                    floatModeTmp)) {
      throw new GLException("Pbuffer-related extensions not supported");
    }

    floatMode = floatModeTmp[0];
    boolean rtt      = capabilities.getPbufferRenderToTexture();
    boolean rect     = capabilities.getPbufferRenderToTextureRectangle();
    boolean useFloat = capabilities.getPbufferFloatingPointBuffers();
    boolean ati      = false;

    if (useFloat) {
      ati = (floatMode == GLPbuffer.ATI_FLOAT);
    }

    int[] pformats = new int[MAX_PFORMATS];
    int   nformats;
    int[] nformatsTmp = new int[1];
    if (!wglExt.wglChoosePixelFormat(parentHdc,
                                     iattributes, 0,
                                     fattributes, 0,
                                     MAX_PFORMATS,
                                     pformats, 0,
                                     nformatsTmp, 0)) {
      throw new GLException("pbuffer creation error: wglChoosePixelFormat() failed");
    }
    nformats = nformatsTmp[0];
    if (nformats <= 0) {
      throw new GLException("pbuffer creation error: Couldn't find a suitable pixel format");
    }

    boolean haveMultisample = wglExt.isExtensionAvailable("WGL_ARB_multisample");

    if (DEBUG) {
      System.err.println("" + nformats + " suitable pixel formats found");
      // query pixel format
      iattributes[0] = WGLExt.WGL_RED_BITS;
      iattributes[1] = WGLExt.WGL_GREEN_BITS;
      iattributes[2] = WGLExt.WGL_BLUE_BITS;
      iattributes[3] = WGLExt.WGL_ALPHA_BITS;
      iattributes[4] = WGLExt.WGL_DEPTH_BITS;
      iattributes[5] = (useFloat ? (ati ? WGLExt.WGL_PIXEL_TYPE: WGLExt.WGL_FLOAT_COMPONENTS_NV) : WGLExt.WGL_RED_BITS);
      iattributes[6] = (haveMultisample ? WGLExt.WGL_SAMPLE_BUFFERS: WGLExt.WGL_RED_BITS);
      iattributes[7] = (haveMultisample ? WGLExt.WGL_SAMPLES: WGLExt.WGL_RED_BITS);
      iattributes[8] = WGLExt.WGL_DRAW_TO_PBUFFER;
      int[] ivalues = new int[9];
      for (int i = 0; i < nformats; i++) {
        if (!wglExt.wglGetPixelFormatAttribiv(parentHdc, pformats[i], 0, 9, iattributes, 0, ivalues, 0)) {
          throw new GLException("Error while querying pixel format " + pformats[i] +
                                "'s (index " + i + "'s) capabilities for debugging");
        }
        System.err.print("pixel format " + pformats[i] + " (index " + i + "): ");
        System.err.print( "r: " + ivalues[0]);
        System.err.print(" g: " + ivalues[1]);
        System.err.print(" b: " + ivalues[2]);
        System.err.print(" a: " + ivalues[3]);
        System.err.print(" depth: " + ivalues[4]);
        if (haveMultisample) {
          System.err.print(" multisample: " + ivalues[6]);
        }
        System.err.print(" samples: " + ivalues[7]);
        if (useFloat) {
          if (ati) {
            if (ivalues[5] == WGLExt.WGL_TYPE_RGBA_FLOAT) {
              System.err.print(" [ati float]");
            } else if (ivalues[5] != WGLExt.WGL_TYPE_RGBA) {
              System.err.print(" [unknown pixel type " + ivalues[5] + "]");
            }
          } else {
            if (ivalues[5] != 0) {
              System.err.print(" [float]");
            }
          }
        }

        if (ivalues[8] != 0) {
          System.err.print(" [pbuffer]");
        }
        System.err.println();
      }
    }

    long tmpBuffer = 0;
    int whichFormat = -1;
    // Loop is a workaround for bugs in NVidia's recent drivers
    for (whichFormat = 0; whichFormat < nformats; whichFormat++) {
      int format = pformats[whichFormat];

      // Create the p-buffer.
      niattribs = 0;

      if (rtt) {
        iattributes[niattribs++]   = WGLExt.WGL_TEXTURE_FORMAT;
        if (useFloat) {
          iattributes[niattribs++] = WGLExt.WGL_TEXTURE_FLOAT_RGB_NV;
        } else {
          iattributes[niattribs++] = WGLExt.WGL_TEXTURE_RGBA;
        }

        iattributes[niattribs++] = WGLExt.WGL_TEXTURE_TARGET;
        iattributes[niattribs++] = rect ? WGLExt.WGL_TEXTURE_RECTANGLE_NV : WGLExt.WGL_TEXTURE_2D;

        iattributes[niattribs++] = WGLExt.WGL_MIPMAP_TEXTURE;
        iattributes[niattribs++] = GL.GL_FALSE;

        iattributes[niattribs++] = WGLExt.WGL_PBUFFER_LARGEST;
        iattributes[niattribs++] = GL.GL_FALSE;
      }

      iattributes[niattribs++] = 0;

      tmpBuffer = wglExt.wglCreatePbuffer(parentHdc, format, getWidth(), getHeight(), iattributes, 0);
      if (tmpBuffer != 0) {
        // Done
        break;
      }
    }

    if (tmpBuffer == 0) {
      throw new GLException("pbuffer creation error: wglCreatePbuffer() failed: tried " + nformats +
                            " pixel formats, last error was: " + wglGetLastError());
    }

    // Get the device context.
    long tmpHdc = wglExt.wglGetPbufferDC(tmpBuffer);
    if (tmpHdc == 0) {
      throw new GLException("pbuffer creation error: wglGetPbufferDC() failed");
    }

    NullWindow nw = (NullWindow) getNativeWindow();
    // Set up instance variables
    buffer = tmpBuffer;
    nw.setSurfaceHandle(tmpHdc);
    cachedWGLExt = wglExt;
    cachedParentHdc = parentHdc;

    // Re-query chosen pixel format
    {
      niattribs = 0;
      iattributes[niattribs++] = WGLExt.WGL_ACCELERATION;
      iattributes[niattribs++] = WGLExt.WGL_RED_BITS;
      iattributes[niattribs++] = WGLExt.WGL_GREEN_BITS;
      iattributes[niattribs++] = WGLExt.WGL_BLUE_BITS;
      iattributes[niattribs++] = WGLExt.WGL_ALPHA_BITS;
      iattributes[niattribs++] = WGLExt.WGL_DEPTH_BITS;
      iattributes[niattribs++] = WGLExt.WGL_STENCIL_BITS;
      iattributes[niattribs++] = WGLExt.WGL_DOUBLE_BUFFER;
      iattributes[niattribs++] = WGLExt.WGL_STEREO;
      iattributes[niattribs++] = WGLExt.WGL_ACCUM_RED_BITS;
      iattributes[niattribs++] = WGLExt.WGL_ACCUM_GREEN_BITS;
      iattributes[niattribs++] = WGLExt.WGL_ACCUM_BLUE_BITS;
      iattributes[niattribs++] = WGLExt.WGL_ACCUM_ALPHA_BITS;
      iattributes[niattribs++] = (useFloat ? (ati ? WGLExt.WGL_PIXEL_TYPE: WGLExt.WGL_FLOAT_COMPONENTS_NV) : WGLExt.WGL_RED_BITS);
      iattributes[niattribs++] = (haveMultisample ? WGLExt.WGL_SAMPLE_BUFFERS: WGLExt.WGL_RED_BITS);
      iattributes[niattribs++] = (haveMultisample ? WGLExt.WGL_SAMPLES: WGLExt.WGL_RED_BITS);
      iattributes[niattribs++] = WGLExt.WGL_DRAW_TO_PBUFFER;
      int[] ivalues = new int[niattribs];
      // FIXME: usually prefer to throw exceptions, but failure here is not critical
      if (wglExt.wglGetPixelFormatAttribiv(parentHdc, pformats[whichFormat], 0, niattribs, iattributes, 0, ivalues, 0)) {
        setChosenGLCapabilities(iattributes2GLCapabilities(iattributes, niattribs, ivalues, false));
      }
    }

    // Determine the actual width and height we were able to create.
    int[] tmp = new int[1];
    wglExt.wglQueryPbuffer( buffer, WGLExt.WGL_PBUFFER_WIDTH,  tmp, 0 );
    width = tmp[0];
    wglExt.wglQueryPbuffer( buffer, WGLExt.WGL_PBUFFER_HEIGHT, tmp, 0 );
    height = tmp[0];
    nw.setSize(width, height);

    if (DEBUG) {
      System.err.println("Created pbuffer " + width + " x " + height);
    }
  }

  private static String wglGetLastError() {
    return WindowsWGLDrawableFactory.wglGetLastError();
  }
}