SoGLDeviceSettings Class

Device settings management class.

Inheritance Hierarchy

SystemObject
OIV.InventorSoNetBase
OIV.Inventor.DevicesSoGLDeviceSettings

Namespace: OIV.Inventor.Devices
Assembly: OIV.Inventor.GL (in OIV.Inventor.GL.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoGLDeviceSettings : SoNetBase

Public Class SoGLDeviceSettings
	Inherits SoNetBase

public ref class SoGLDeviceSettings : public SoNetBase

type SoGLDeviceSettings =  
    class
        inherit SoNetBase
    end

The SoGLDeviceSettings type exposes the following members.

Methods

	Name	Description
	ApplySettings	Apply changes to the setting and/or parameters.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetParameter	Returns current value of specified parameter in current setting.
	GetParameterCount	Returns number of parameters in current setting.
	GetParameterIdbyIndex	Returns the name of the parameter with the specified index in the current setting.
	GetSettingName	Returns the name of the current setting (vendor defined list of parameters).
	GetSettingNameByIndex	Returns the name of the specified setting.
	GetSettingsCount	Returns the number of vendor defined settings.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetParameter	Set the value of a parameter in the current setting.
	SetSettingName	Set a setting (vendor defined list of parameters) by name.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class provides functions to query and modify information about OpenGL device settings. A setting is a vendor defined collection of device dependent parameters like "Stereo - Enable", "Antialiasing ? Mode" or "Vertical Sync". NVIDIA calls this a "driver profile". Parameters can be set as a group using #SetSettingName(),with a predefined name, or one by one using #SetParameter(). Applications should only create an SoDeviceSettings object using the OIV.Inventor.Devices.SoGLDevice method GetDeviceSettings()(see below).

Device settings should be changed before any rendering is done, i.e. before the OpenGL render context is created.

Setting and parameter changes do not take effect until OIV.Inventor.Devices.SoGLDeviceSettings.ApplySettings() is called.

Changes should only affect the current running application (but this may depend on the graphics board vendor and driver installed).

The settings and parameters that can be queried through this interface may not correspond to the parameters displayed by the graphics board vendor's "control panel" application. This depends on the vendor and the driver installed.

EXAMPLE

Set a predefined driver setting (profile) for an NVIDIA graphics board.

Copy

SoGLDevice gldevice = SoGLDevice.GetDevice( 0 );
SoGLDeviceSettings devSettings = gldevice.GetDeviceSettings();
if (devSettings != null)
{
 devSettings.SetSettingName( "Workstation App - Dynamic Streaming" );
 devSettings.ApplySettings();
}

Reference

OIV.Inventor.Devices Namespace

OIV.Inventor.Devices.SoGLDevice