aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/javax/media/opengl/GLCapabilitiesImmutable.java
blob: 7e0459b2dd79ef0aaacda57061970942a01a4ea2 (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
/**
 * 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 javax.media.opengl;

import javax.media.nativewindow.CapabilitiesImmutable;

/**
 * Specifies an immutable set of OpenGL capabilities.<br>
 *
 * @see javax.media.opengl.GLCapabilities
 * @see javax.media.nativewindow.CapabilitiesImmutable
 */
public interface GLCapabilitiesImmutable extends CapabilitiesImmutable {
    /** 
     * One of the platform's default sample extension 
     * <code>EGL.EGL_SAMPLES, GLX.GLX_SAMPLES, WGLExt.WGL_SAMPLES_ARB</code>
     * if available, or any other <i>known</i> fallback one, ie <code>EGLExt.EGL_COVERAGE_SAMPLES_NV</code>
     */
    public static final String DEFAULT_SAMPLE_EXTENSION = "default" ;
    
    /**
     * Returns the GL profile you desire or used by the drawable.
     */
    GLProfile getGLProfile();

    /**
     * Returns the number of bits requested for the accumulation
     * buffer's alpha component. On some systems only the accumulation
     * buffer depth, which is the sum of the red, green, and blue bits,
     * is considered.
     */
    int getAccumAlphaBits();

    /**
     * Returns the number of bits requested for the accumulation
     * buffer's blue component. On some systems only the accumulation
     * buffer depth, which is the sum of the red, green, and blue bits,
     * is considered.
     */
    int getAccumBlueBits();

    /**
     * Returns the number of bits requested for the accumulation
     * buffer's green component. On some systems only the accumulation
     * buffer depth, which is the sum of the red, green, and blue bits,
     * is considered.
     */
    int getAccumGreenBits();

    /**
     * Returns the number of bits requested for the accumulation
     * buffer's red component. On some systems only the accumulation
     * buffer depth, which is the sum of the red, green, and blue bits,
     * is considered.
     */
    int getAccumRedBits();

    /**
     * Returns the number of bits requested for the depth buffer.
     */
    int getDepthBits();

    /**
     * Indicates whether double-buffering is enabled.
     */
    boolean getDoubleBuffered();

    /**
     * Indicates whether hardware acceleration is enabled.
     */
    boolean getHardwareAccelerated();

    /**
     * Returns the used extension for full-scene antialiasing
     * (FSAA), default is {@link #DEFAULT_SAMPLE_EXTENSION}.
     */
    String getSampleExtension();
    
    /**
     * Returns whether sample buffers for full-scene antialiasing
     * (FSAA) should be allocated for this drawable. Defaults to
     * false.
     */
    boolean getSampleBuffers();

    /**
     * Returns the number of sample buffers to be allocated if sample
     * buffers are enabled, otherwise returns 0. Defaults to 2.
     */
    int getNumSamples();

    /**
     * For pbuffers only, returns whether floating-point buffers should
     * be used if available. Defaults to false.
     */
    boolean getPbufferFloatingPointBuffers();

    /**
     * For pbuffers only, returns whether the render-to-texture
     * extension should be used if available.  Defaults to false.
     */
    boolean getPbufferRenderToTexture();

    /**
     * For pbuffers only, returns whether the render-to-texture
     * extension should be used. Defaults to false.
     */
    boolean getPbufferRenderToTextureRectangle();

    /**
     * Returns the number of bits requested for the stencil buffer.
     */
    int getStencilBits();

    /**
     * Indicates whether stereo is enabled.
     */
    boolean getStereo();

    /**
     * Indicates whether pbuffer offscreen is used/requested.
     */
    boolean isPBuffer();

    /**
     * Indicates whether FBO offscreen is used/requested.
     */
    boolean isFBO();

    @Override
    boolean equals(Object obj);

    @Override
    int hashCode();

    @Override
    String toString();
}