Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
SoGraphicConfigTemplate Class Referenceabstract
Inventor » General

VSG extension Abstract base class for graphics configuration template classes. More...

#include <Inventor/components/SoGraphicConfigTemplate.h>

+ Inheritance diagram for SoGraphicConfigTemplate:

Public Types

enum  Preference {
  REQUIRED = INT_MAX ,
  PREFERRED = 16 ,
  FORBIDDEN = 0
}
 Priority requirement. More...
 

Public Member Functions

 SoGraphicConfigTemplate ()
 Constructor.
 
virtual ~SoGraphicConfigTemplate ()
 Destructor.
 
virtual SbBool isGraphicsConfigSupported (SoGraphicConfig &graphicConfig) const =0
 Indicates if the graphics configuration graphicConfig fits this template.
 

Detailed Description

VSG extension Abstract base class for graphics configuration template classes.

This abstract class allows you to specify a set of graphics preferences. It can be used to choose a particular configuration of a graphics device. A graphics configuration matches this template only if

  • all REQUIRED fields are "active"
  • all FORBIDDEN fields are "inactive"

SEE ALSO

SoGraphicConfigTemplate, SoGLGraphicConfigTemplate, SoGraphicConfig, SoGLGraphicConfig, SoGLGraphicDevice.

Definition at line 47 of file SoGraphicConfigTemplate.h.

Member Enumeration Documentation

◆ Preference

enum SoGraphicConfigTemplate::Preference

Priority requirement.

Enumerator
REQUIRED 

Means crucial and absolutely required.

PREFERRED 

Means "better if available" but not crucial.

Any other positive int value correspond to a priority level (the max priority correspond to REQUIRED).

FORBIDDEN 

Means absolutely forbidden.

Definition at line 65 of file SoGraphicConfigTemplate.h.

Constructor & Destructor Documentation

◆ SoGraphicConfigTemplate()

SoGraphicConfigTemplate::SoGraphicConfigTemplate ( )

Constructor.

◆ ~SoGraphicConfigTemplate()

virtual SoGraphicConfigTemplate::~SoGraphicConfigTemplate ( )
inlinevirtual

Destructor.

Definition at line 60 of file SoGraphicConfigTemplate.h.

Member Function Documentation

◆ isGraphicsConfigSupported()

virtual SbBool SoGraphicConfigTemplate::isGraphicsConfigSupported ( SoGraphicConfig &  graphicConfig) const
pure virtual

Indicates if the graphics configuration graphicConfig fits this template.

Returns TRUE if all REQUIRED fields in the template are active in graphicConfig and if all FORBIDDEN fields in the template are inactive in graphicConfig.

Implemented in SoGLGraphicConfigTemplate.

The documentation for this class was generated from the following file: