JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
GLCapabilitiesImmutable.java
Go to the documentation of this file.
1/**
2 * Copyright 2010 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.opengl;
30
31import com.jogamp.nativewindow.CapabilitiesImmutable;
32
33/**
34 * Specifies an immutable set of OpenGL capabilities.<br>
35 *
36 * @see com.jogamp.opengl.GLCapabilities
37 * @see com.jogamp.nativewindow.CapabilitiesImmutable
38 */
40 /**
41 * One of the platform's default sample extension
42 * <code>EGL.EGL_SAMPLES, GLX.GLX_SAMPLES, WGLExt.WGL_SAMPLES_ARB</code>
43 * if available, or any other <i>known</i> fallback one, ie <code>EGLExt.EGL_COVERAGE_SAMPLES_NV</code>
44 */
45 public static final String DEFAULT_SAMPLE_EXTENSION = "default" ;
46
47 /**
48 * Returns the GL profile you desire or used by the drawable.
49 */
51
52 /**
53 * Returns the number of bits for the accumulation
54 * buffer's alpha component. On some systems only the accumulation
55 * buffer depth, which is the sum of the red, green, and blue bits,
56 * is considered.
57 */
59
60 /**
61 * Returns the number of bits for the accumulation
62 * buffer's blue component. On some systems only the accumulation
63 * buffer depth, which is the sum of the red, green, and blue bits,
64 * is considered.
65 */
67
68 /**
69 * Returns the number of bits for the accumulation
70 * buffer's green component. On some systems only the accumulation
71 * buffer depth, which is the sum of the red, green, and blue bits,
72 * is considered.
73 */
75
76 /**
77 * Returns the number of bits for the accumulation
78 * buffer's red component. On some systems only the accumulation
79 * buffer depth, which is the sum of the red, green, and blue bits,
80 * is considered.
81 */
83
84 /**
85 * Returns the number of depth buffer bits.
86 */
88
89 /**
90 * Returns whether double-buffering is requested, available or chosen.
91 * <p>
92 * Default is true.
93 * </p>
94 */
96
97 /**
98 * Returns whether hardware acceleration is requested, available or chosen.
99 * <p>
100 * Default is true.
101 * </p>
102 */
104
105 /**
106 * Returns the extension for full-scene antialiasing
107 * (FSAA).
108 * <p>
109 * Default is {@link #DEFAULT_SAMPLE_EXTENSION}.
110 * </p>
111 */
113
114 /**
115 * Returns whether sample buffers for full-scene antialiasing
116 * (FSAA) should be allocated for this drawable.
117 * <p>
118 * Default is false.
119 * </p>
120 */
122
123 /**
124 * Returns the number of sample buffers to be allocated if sample
125 * buffers are enabled, otherwise returns 0.
126 * <p>
127 * Default is 0 due to disable sample buffers per default.
128 * </p>
129 */
131
132 /**
133 * Returns the number of stencil buffer bits.
134 * <p>
135 * Default is 0.
136 * </p>
137 */
139
140 /**
141 * Returns whether stereo is requested, available or chosen.
142 * <p>
143 * Default is false.
144 * </p>
145 */
146 boolean getStereo();
147
148 /**
149 * Returns whether pbuffer offscreen mode is requested, available or chosen.
150 * <p>
151 * Default is false.
152 * </p>
153 * <p>
154 * For chosen capabilities, only the selected offscreen surface is set to <code>true</code>.
155 * </p>
156 */
157 boolean isPBuffer();
158
159 /**
160 * Returns whether FBO offscreen mode is requested, available or chosen.
161 * <p>
162 * Default is false.
163 * </p>
164 * <p>
165 * For chosen capabilities, only the selected offscreen surface is set to <code>true</code>.
166 * </p>
167 */
168 boolean isFBO();
169
170 @Override
171 boolean equals(Object obj);
172
173 @Override
174 int hashCode();
175
176 @Override
177 String toString();
178}
Specifies the the OpenGL profile.
Definition: GLProfile.java:77
Specifies an immutable set of capabilities that a window's rendering context must support,...
Specifies an immutable set of OpenGL capabilities.
boolean getSampleBuffers()
Returns whether sample buffers for full-scene antialiasing (FSAA) should be allocated for this drawab...
int getAccumGreenBits()
Returns the number of bits for the accumulation buffer's green component.
String getSampleExtension()
Returns the extension for full-scene antialiasing (FSAA).
int getNumSamples()
Returns the number of sample buffers to be allocated if sample buffers are enabled,...
boolean getHardwareAccelerated()
Returns whether hardware acceleration is requested, available or chosen.
int getDepthBits()
Returns the number of depth buffer bits.
String toString()
Returns a textual representation of this object.
boolean isPBuffer()
Returns whether pbuffer offscreen mode is requested, available or chosen.
GLProfile getGLProfile()
Returns the GL profile you desire or used by the drawable.
int getAccumRedBits()
Returns the number of bits for the accumulation buffer's red component.
int getAccumAlphaBits()
Returns the number of bits for the accumulation buffer's alpha component.
boolean equals(Object obj)
Equality over the immutable attributes of both objects.
boolean getDoubleBuffered()
Returns whether double-buffering is requested, available or chosen.
int getAccumBlueBits()
Returns the number of bits for the accumulation buffer's blue component.
boolean isFBO()
Returns whether FBO offscreen mode is requested, available or chosen.
int getStencilBits()
Returns the number of stencil buffer bits.
int hashCode()
Hash code over the immutable attributes.
static final String DEFAULT_SAMPLE_EXTENSION
One of the platform's default sample extension EGL.EGL_SAMPLES, GLX.GLX_SAMPLES, WGLExt....
boolean getStereo()
Returns whether stereo is requested, available or chosen.