Click or drag to resize
SoGLGraphicConfigTemplate Class

Defines an OpenGL graphics configuration template.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.ComponentsSoGraphicConfigTemplate
      OIV.Inventor.ComponentsSoGLGraphicConfigTemplate

Namespace: OIV.Inventor.Components
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
Syntax
public class SoGLGraphicConfigTemplate : SoGraphicConfigTemplate

The SoGLGraphicConfigTemplate type exposes the following members.

Constructors
  NameDescription
Public methodSoGLGraphicConfigTemplate

Constructor.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAccelerated

Returns the graphics acceleration preference.

Public methodGetAccum

Returns the accumulation buffer preferences.

Public methodGetDepth

Returns the depth buffer preference and sizes.

Public methodGetDoubleBuffer

Returns the double buffer mode preference.

Public methodGetFloatRGBAColor

Returns the float color preferences.

Public methodGetFullSceneAntialiasing

Returns the full-scene antialiasing preference and number of samples.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetRGBAColor

Returns the color preferences.

Public methodGetStencil

Returns the stencil preferences.

Public methodGetStereoBuffer

Returns the stereo buffer preference.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsFloatRGBAColor

Returns true if floating point RGBA is used.

Public methodIsGraphicsConfigSupported

Indicates if the graphics configuration graphicConfig fits this template.

(Inherited from SoGraphicConfigTemplate.)
Public methodSetAccelerated

Sets the graphics acceleration preference.

Public methodSetAccum(SoGraphicConfigTemplatePreferences)
Calls SetAccum(pref, System.Int32(0), System.Int32(0), System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32)
Calls SetAccum(pref, minRedBits, System.Int32(0), System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, minBlueBits, System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, INT_MAX, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, maxGreenBits, INT_MAX, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetAccum(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, maxGreenBits, maxBlueBits, INT_MAX).
Public methodSetAccum(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Sets the accumulation preferences.

Public methodSetDepth(SoGraphicConfigTemplatePreferences)
Calls SetDepth(pref, System.Int32(0), INT_MAX).
Public methodSetDepth(SoGraphicConfigTemplatePreferences, Int32)
Calls SetDepth(pref, minBits, INT_MAX).
Public methodSetDepth(SoGraphicConfigTemplatePreferences, Int32, Int32)

Sets the depth buffer preferences.

Public methodSetDoubleBuffer

Sets the double buffer mode preference.

Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences)
Calls SetFloatRGBAColor(pref, 15, 15, 15, 15, 16, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, 15, 15, 15, 16, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, 15, 15, 16, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, minFloatBlueBits, 15, 16, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, minFloatBlueBits, minFloatAlphaBits, 16, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, minFloatBlueBits, minFloatAlphaBits, maxFloatRedBits, 16, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, minFloatBlueBits, minFloatAlphaBits, maxFloatRedBits, maxFloatGreenBits, 16, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetFloatRGBAColor(pref, minFloatRedBits, minFloatGreenBits, minFloatBlueBits, minFloatAlphaBits, maxFloatRedBits, maxFloatGreenBits, maxFloatBlueBits, 16).
Public methodSetFloatRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Sets the float color preferences.

Public methodSetFullSceneAntialiasing(SoGraphicConfigTemplatePreferences)
Calls SetFullSceneAntialiasing(pref, System.Int32(0), INT_MAX).
Public methodSetFullSceneAntialiasing(SoGraphicConfigTemplatePreferences, Int32)
Calls SetFullSceneAntialiasing(pref, minFsaaBits, INT_MAX).
Public methodSetFullSceneAntialiasing(SoGraphicConfigTemplatePreferences, Int32, Int32)

Sets the full-scene antialiasing preferences.

Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences)
Calls SetRGBAColor(pref, System.Int32(0), System.Int32(0), System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32)
Calls SetRGBAColor(pref, minRedBits, System.Int32(0), System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, System.Int32(0), System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, minBlueBits, System.Int32(0), INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, INT_MAX, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, INT_MAX, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, maxGreenBits, INT_MAX, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32)
Calls SetRGBAColor(pref, minRedBits, minGreenBits, minBlueBits, minAlphaBits, maxRedBits, maxGreenBits, maxBlueBits, INT_MAX).
Public methodSetRGBAColor(SoGraphicConfigTemplatePreferences, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Sets the color preferences.

Public methodSetStencil(SoGraphicConfigTemplatePreferences)
Calls SetStencil(pref, System.Int32(0), INT_MAX).
Public methodSetStencil(SoGraphicConfigTemplatePreferences, Int32)
Calls SetStencil(pref, minBits, INT_MAX).
Public methodSetStencil(SoGraphicConfigTemplatePreferences, Int32, Int32)

Sets the stencil preferences.

Public methodSetStereoBuffer

Sets the stereo buffer mode preference.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

An OpenGL graphics configuration template is a set of graphics preferences used to choose the best OpenGL graphics configuration (OIV.Inventor.Components.SoGLGraphicConfig) available on an OpenGL graphics device (OIV.Inventor.Components.SoGLGraphicDevice).

There are many different criteria: double/single buffer, raw stereo, OpenGL acceleration, Z-buffer depth size, RGBA/indexed colors and size, accumulation buffer and size, stencil buffer and size, etc. Every criterion is required, or forbidden, or preferred. The preferred criterion can be extended to an integer weight: OIV.Inventor.Components.SoGraphicConfigTemplate.Preferences.PREFERRED (equal to 1), 2, 3, 4, 10, 100, 1000, and so forth. The sum of all weights determines if one graphics configuration is better than another.

The default values are:

  • Double buffer is REQUIRED;

  • Stereo buffer is FORBIDDEN;

  • Accelerated OpenGL is REQUIRED;

  • Depth buffer is REQUIRED; its size is greater than 0;

  • Non-indexed color is REQUIRED; its R/G/B/A sizes are greater than 0;

  • Indexed color is FORBIDDEN;

  • Accumulation buffer is PREFERRED (weight 1); its R/G/B/A sizes are greater than 0;

  • Stencil buffer is PREFERRED(weight 1); its size is greater than 0;

  • Full-scene antialiasing is FORBIDDEN.

See Also