SoGLFormat

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.devices.SoGLFormat

All Implemented Interfaces:

java.lang.Cloneable
```
public class SoGLFormat
extends Inventor
implements java.lang.Cloneable
```
OpenGL pixel format management class. This class provides functions to manage OpenGL pixel formats.

Nested Class Summary
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

Field Summary
- Fields inherited from class com.openinventor.inventor.Inventor
  VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description
`SoGLFormat()` Default constructor -> we set the default format.
`SoGLFormat(SoGLFormat refFormat)` Constructor that initializes the format from the specified one.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`activate()` Tries to activate the format for the current display.
`java.lang.Object`	`clone()`
`int`	`getAccumBufferBits()` Returns the accumulation buffer bits of this format.
`int`	`getAlphaBits()`
`int`	`getBlueBits()`
`static SoGLFormat`	`getDefaultFormat()` Returns the default format used.
`static SoGLFormat`	`getDefaultOverlayFormat()` Deprecated. As of Open Inventor 9610 See documentation for more details
`int`	`getDepthBits()` Returns the depth buffer bits of this format.
`int`	`getGreenBits()`
`SoGLFormat`	`getNearest()` Returns the supported format which is the nearest available on this system.
`int`	`getPlane()` Deprecated. As of Open Inventor 9610 See documentation for more details
`int`	`getRedBits()`
`int`	`getSamplesCount()` Returns the samples count of this format.
`int`	`getStencilBufferBits()` Returns the stencil buffer bits of this format.
`int`	`getVisualInfoId()` Returns the PFD associated with this visualInfo.
`boolean`	`hasAccumBuffer()` Returns true if this format has an accumulation buffer.
`boolean`	`hasAlpha()` Returns true if this format has an alpha channel.
`boolean`	`hasDepth()` Returns true if this format has a depth buffer.
`boolean`	`hasDoubleBuffers()` Returns true if this format is double buffered.
`boolean`	`hasFloatColorBuffer()` Returns true if this format has a float color buffer.
`boolean`	`hasOverlay()` Deprecated. As of Open Inventor 9610 See documentation for more details
`boolean`	`hasRgb()` Returns true if this format is RGB.
`boolean`	`hasSampleBuffers()` Returns true if this format has sample buffers.
`boolean`	`hasStencilBuffer()` Returns true if this format has a stencil buffer.
`boolean`	`hasStereo()` Returns true if this format has stereo.
`boolean`	`isAccelerationRequired()` Returns true if hardware acceleration support is required for this pixel format.
`boolean`	`isAvailable()` Returns true if this format is available on the system.
`boolean`	`isCompositionRequired()` Returns true if composition is required for this pixel format.
`boolean`	`isGDISupportRequired()` Returns true if GDI support is required for this pixel format.
`boolean`	`isSoftwareRendererRequired()` Returns true if the software renderer is required for this format.
`void`	`setAccelerationRequired(boolean enable)` Sets the hardware acceleration support requirement of this pixel format.
`void`	`setAccumBufferBits(int size)` Sets the accumulation buffer bits of this format.
`void`	`setAccumBufferEnabled(boolean enabled)` Sets the accumulation buffer state of this format.
`void`	`setAlphaBits(int bits)`
`void`	`setAlphaEnabled(boolean enable)` Sets the alpha channel state of this format.
`void`	`setBlueBits(int bits)`
`void`	`setCompositionRequired(boolean required)` Sets the composition requirement of the pixel format.
`void`	`setDepthBits(int bits)` Sets the depth buffer bits of this format.
`void`	`setDepthEnabled(boolean enable)` Sets the depth buffer state of this format.
`void`	`setDoubleBuffersEnabled(boolean enabled)` Sets the double buffering state of this format.
`void`	`setFloatColorBufferEnabled(boolean enable)` Sets the Float color buffer state of this format.
`void`	`setGDISupportRequired(boolean required)` Sets the GDI support requirement of the pixel format.
`void`	`setGreenBits(int bits)`
`void`	`setOverlayEnabled(boolean enabled)` Deprecated. As of Open Inventor 9610 See documentation for more details
`void`	`setPlane(int plane)` Deprecated. As of Open Inventor 9610 See documentation for more details
`void`	`setRedBits(int bits)`
`void`	`setRgbEnabled(boolean enabled)` Sets the RGB state of this format.
`void`	`setSampleBuffersEnabled(boolean enable)` Sets the sample buffers state of this format.
`void`	`setSamplesCount(int countSamples)` Sets the samples count of this format.
`void`	`setSoftwareRendererRequired(boolean enable)` Specified that a software renderer is required for this format.
`void`	`setStencilBufferBits(int size)` Sets the stencil buffer bits of this format.
`void`	`setStencilBufferEnabled(boolean enabled)` Sets the stencil buffer state of this format.
`void`	`setStereoEnabled(boolean enable)` Sets the stereo state of this format.
`void`	`setVisualInfoId(int viId)` Sets the PFD id associated with this visualInfo.

Methods inherited from class com.openinventor.inventor.Inventor
dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SoGLFormat
```
public SoGLFormat()
```
    Default constructor -> we set the default format.
  - SoGLFormat
```
public SoGLFormat(SoGLFormat refFormat)
```
    Constructor that initializes the format from the specified one.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - isAccelerationRequired
```
public boolean isAccelerationRequired()
```
    Returns true if hardware acceleration support is required for this pixel format.
  - getDepthBits
```
public int getDepthBits()
```
    Returns the depth buffer bits of this format.
  - setVisualInfoId
```
public void setVisualInfoId(int viId)
```
    Sets the PFD id associated with this visualInfo.
  - isGDISupportRequired
```
public boolean isGDISupportRequired()
```
    Returns true if GDI support is required for this pixel format.
  - hasOverlay
```
@Deprecated
public boolean hasOverlay()
```
    Deprecated. As of Open Inventor 9610 See documentation for more details
    
    Returns true if this format has an overlay plane. Deprecated since Open Inventor 9610
    Overlay feature is legacy, and no longer makes sense with current hardware.
  - setGDISupportRequired
```
public void setGDISupportRequired(boolean required)
```
    Sets the GDI support requirement of the pixel format.
    This requirement is ignored on non-Microsoft platforms.
    Note: If both setCompositionRequired() and setGDISupportRequired() are set OpenInventor will try to choose a pixel format with composition support.
    The default value is true but setting composition required to true automatically disables GDI support.
  - hasAlpha
```
public boolean hasAlpha()
```
    Returns true if this format has an alpha channel.
  - setAccelerationRequired
```
public void setAccelerationRequired(boolean enable)
```
    Sets the hardware acceleration support requirement of this pixel format.
  - setAlphaEnabled
```
public void setAlphaEnabled(boolean enable)
```
    Sets the alpha channel state of this format.
  - setDoubleBuffersEnabled
```
public void setDoubleBuffersEnabled(boolean enabled)
```
    Sets the double buffering state of this format.
  - getDefaultFormat
```
public static SoGLFormat getDefaultFormat()
```
    Returns the default format used.
  - hasDoubleBuffers
```
public boolean hasDoubleBuffers()
```
    Returns true if this format is double buffered.
  - getDefaultOverlayFormat
```
@Deprecated
public static SoGLFormat getDefaultOverlayFormat()
```
    Deprecated. As of Open Inventor 9610 See documentation for more details
    
    Returns the default format for the overlay planes. Deprecated since Open Inventor 9610
    This feature is legacy, and no longer makes sense with current hardware.
  - isSoftwareRendererRequired
```
public boolean isSoftwareRendererRequired()
```
    Returns true if the software renderer is required for this format.
  - setDepthEnabled
```
public void setDepthEnabled(boolean enable)
```
    Sets the depth buffer state of this format.
  - getVisualInfoId
```
public int getVisualInfoId()
```
    Returns the PFD associated with this visualInfo.
  - setDepthBits
```
public void setDepthBits(int bits)
```
    Sets the depth buffer bits of this format.
  - hasDepth
```
public boolean hasDepth()
```
    Returns true if this format has a depth buffer.
  - setSoftwareRendererRequired
```
public void setSoftwareRendererRequired(boolean enable)
```
    Specified that a software renderer is required for this format. This option is set to false by default. If this option is set to true it overrides setAccelerationRequired().
    Note: This method is only implemented on Microsoft platforms in order to use the generic renderer provided by Microsoft.
    Note: This option is currently checked only by the QtViewer classes (to switch on or off direct rendering).
  - setFloatColorBufferEnabled
```
public void setFloatColorBufferEnabled(boolean enable)
```
    Sets the Float color buffer state of this format.
  - setRedBits
```
public void setRedBits(int bits)
```
  - setStencilBufferBits
```
public void setStencilBufferBits(int size)
```
    Sets the stencil buffer bits of this format.
  - getRedBits
```
public int getRedBits()
```
  - hasStencilBuffer
```
public boolean hasStencilBuffer()
```
    Returns true if this format has a stencil buffer.
  - setRgbEnabled
```
public void setRgbEnabled(boolean enabled)
```
    Sets the RGB state of this format.
  - setAccumBufferEnabled
```
public void setAccumBufferEnabled(boolean enabled)
```
    Sets the accumulation buffer state of this format.
  - hasRgb
```
public boolean hasRgb()
```
    Returns true if this format is RGB.
  - getStencilBufferBits
```
public int getStencilBufferBits()
```
    Returns the stencil buffer bits of this format.
  - getBlueBits
```
public int getBlueBits()
```
  - setBlueBits
```
public void setBlueBits(int bits)
```
  - setAlphaBits
```
public void setAlphaBits(int bits)
```
  - getAlphaBits
```
public int getAlphaBits()
```
  - setGreenBits
```
public void setGreenBits(int bits)
```
  - setStencilBufferEnabled
```
public void setStencilBufferEnabled(boolean enabled)
```
    Sets the stencil buffer state of this format.
  - getGreenBits
```
public int getGreenBits()
```
  - hasFloatColorBuffer
```
public boolean hasFloatColorBuffer()
```
    Returns true if this format has a float color buffer.
  - hasStereo
```
public boolean hasStereo()
```
    Returns true if this format has stereo.
  - activate
```
public boolean activate()
```
    Tries to activate the format for the current display.
    The display must be valid (see the setDisplay() function).
  - getPlane
```
@Deprecated
public int getPlane()
```
    Deprecated. As of Open Inventor 9610 See documentation for more details
    
    Returns the plane of this format. Deprecated since Open Inventor 9610
    Overlay feature is legacy, and no longer makes sense with current hardware.
  - getNearest
```
public SoGLFormat getNearest()
```
    Returns the supported format which is the nearest available on this system.
    The display must be valid (see the setDisplay() function).
  - setSampleBuffersEnabled
```
public void setSampleBuffersEnabled(boolean enable)
```
    Sets the sample buffers state of this format.
  - isCompositionRequired
```
public boolean isCompositionRequired()
```
    Returns true if composition is required for this pixel format.
  - setOverlayEnabled
```
@Deprecated
public void setOverlayEnabled(boolean enabled)
```
    Deprecated. As of Open Inventor 9610 See documentation for more details
    
    Sets the overlay state of this format. Deprecated since Open Inventor 9610
    Overlay feature is legacy, and no longer makes sense with current hardware.
  - setCompositionRequired
```
public void setCompositionRequired(boolean required)
```
    Sets the composition requirement of the pixel format.
    This requirement is ignored on non-Microsoft platforms and on Windows platforms before Windows Vista. Requiring composition will automatically disable GDI support for this format (this is a Microsoft limitation).
    Note: If both setCompositionRequired() and setGDISupportRequired() are set OpenInventor will try to choose a pixel format with composition support.
    The default value is false but can be overridden using the OIV_PFD_SUPPORT_COMPOSITION preference (see SoPreferences).
  - setPlane
```
@Deprecated
public void setPlane(int plane)
```
    Deprecated. As of Open Inventor 9610 See documentation for more details
    
    Sets the plane of this format. The plane parameter indicates the OpenGL plane on which the format applies. Plane 0 is the main OpenGL plane, a negative value indicates an underlay plane, while a positive value indicates an overlay plane.
    By default the plane is set to the main plane.Deprecated since Open Inventor 9610
    Overlay feature is legacy, and no longer makes sense with current hardware.
  - setAccumBufferBits
```
public void setAccumBufferBits(int size)
```
    Sets the accumulation buffer bits of this format.
  - getSamplesCount
```
public int getSamplesCount()
```
    Returns the samples count of this format.
  - hasAccumBuffer
```
public boolean hasAccumBuffer()
```
    Returns true if this format has an accumulation buffer.
  - setStereoEnabled
```
public void setStereoEnabled(boolean enable)
```
    Sets the stereo state of this format.
  - isAvailable
```
public boolean isAvailable()
```
    Returns true if this format is available on the system.
    The display must be valid (see the setDisplay() function).
  - hasSampleBuffers
```
public boolean hasSampleBuffers()
```
    Returns true if this format has sample buffers.
  - getAccumBufferBits
```
public int getAccumBufferBits()
```
    Returns the accumulation buffer bits of this format.
  - setSamplesCount
```
public void setSamplesCount(int countSamples)
```
    Sets the samples count of this format.

Class SoGLFormat

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Constructor Detail

SoGLFormat

SoGLFormat

Method Detail

clone

isAccelerationRequired

getDepthBits

setVisualInfoId

isGDISupportRequired

hasOverlay

setGDISupportRequired

hasAlpha

setAccelerationRequired

setAlphaEnabled

setDoubleBuffersEnabled

getDefaultFormat

hasDoubleBuffers

getDefaultOverlayFormat

isSoftwareRendererRequired

setDepthEnabled

getVisualInfoId

setDepthBits

hasDepth

setSoftwareRendererRequired

setFloatColorBufferEnabled

setRedBits

setStencilBufferBits

getRedBits

hasStencilBuffer

setRgbEnabled

setAccumBufferEnabled

hasRgb

getStencilBufferBits

getBlueBits

setBlueBits

setAlphaBits

getAlphaBits

setGreenBits

setStencilBufferEnabled

getGreenBits

hasFloatColorBuffer

hasStereo

activate

getPlane

getNearest

setSampleBuffersEnabled

isCompositionRequired

setOverlayEnabled

setCompositionRequired

setPlane

setAccumBufferBits

getSamplesCount

hasAccumBuffer

setStereoEnabled

isAvailable

hasSampleBuffers

getAccumBufferBits

setSamplesCount